Skip to content

Commit

Permalink
skip win+3.8 and add minimal info to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jensens committed Mar 11, 2024
1 parent 14a112a commit 59ddd51
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ jobs:
- ubuntu-latest
- macos-latest
- windows-latest
exclude:
- python-version: "3.8"
os: windows-latest
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
Expand Down
16 changes: 11 additions & 5 deletions docs/source/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,6 @@ cd myproject

You can either install *mxmake* globally or in a virtual environment.

```{note}
While *mxstack* is under development, use the unreleased `develop` branch and install with
`pip install git+https://github.com/mxstack/mxmake.git@develop`.
```

For global installation do a `pip install mxmake`, otherwise create a virtual environment, activate it, and install it like so:

```shell
Expand Down Expand Up @@ -64,3 +59,14 @@ Each setting provides a description and an optional default value.
To update the Makefile without beeing prompted interactive, run `mxmake update`.

For details read the chapter [on topics and it's domains](topics-and-domains).


## How to use on the Windows operating system

mxmake on Windows needs a bash shell.
Fortunatly the GIT VCS comes with the git-bash.
Please follow [GIT's official installation instructions](https://git-scm.com/download/win).

Further you need a [Python >=3.9 installation.](https://www.python.org/downloads/windows/).

Dependent on the topics and domains you use, you might need to install additional software.

0 comments on commit 59ddd51

Please sign in to comment.