Skip to content

Commit 1e6a13f

Browse files
fmhossairjb75
authored andcommitted
docs(readme): Add Windows Installation instructions
1 parent 72391a5 commit 1e6a13f

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

+25
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,31 @@ or
4141

4242
If you're on VS Code, you should consider using the [__Python Docstring Generator__ extension](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring) on the Google docstring configuration. If you prefer other editors, please make sure your commits follow the current docstring convention.
4343

44+
### Windows Installation
45+
46+
Install [pyenv-win](https://github.com/pyenv-win/pyenv-win) to easily switch between Python versions. From pyenv, install python 3.9.1 and set it as the Python verion of the current repo.
47+
48+
Once pyenv is setup, install [poetry](https://github.com/python-poetry/poetry#installation), change directory in your
49+
terminal towards the project folder and run the following command
50+
51+
`poetry shell`
52+
53+
to run a virtual enviroment, then
54+
55+
`poetry install`
56+
57+
after that, run the following command to install pre-commit scripts
58+
59+
`pre-commit install`
60+
61+
finally, run the demo by just entering this command
62+
63+
`python -m systems`
64+
65+
or
66+
67+
`poetry run python -m systems`
68+
4469
### Using Docker (beta)
4570

4671
*Natively only supported on Linux and MacOS - use WSL 2 on Windows*

0 commit comments

Comments
 (0)