Skip to content

Commit 1172a87

Browse files
authored
Merge pull request #845 from DaveTrost/contributors-setup-on-windows
setup updates for contributors on Windows
2 parents c8a07d6 + 5790ec4 commit 1172a87

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,15 @@ Once you have verified that you system matches the base requirements you can sta
2929
2. Clone your fork to your local file system:
3030
`git clone https://github.com/$GITHUB_ACCOUNT/hug.git`
3131
3. `cd hug`
32+
- Create a virtual environment using [`python3 -m venv $ENV_NAME`](https://docs.python.org/3/library/venv.html) or `mkvirtualenv` (from [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/))
3233
- If you have autoenv set-up correctly, simply press Y and then wait for the environment to be set up for you.
3334
- If you don't have autoenv set-up, run `source .env` to set up the local environment. You will need to run this script every time you want to work on the project - though it will not cause the entire set up process to re-occur.
3435
4. Run `test` to verify your everything is set up correctly. If the tests all pass, you have successfully set up hug for local development! If not, you can ask for help diagnosing the error [here](https://gitter.im/timothycrosley/hug).
3536

36-
At step 3, you can skip using autoenv and the `.env` script,
37-
and create your development virtul environment manually instead
38-
using e.g. [`python3 -m venv`](https://docs.python.org/3/library/venv.html)
39-
or `mkvirtualenv` (from [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/)).
40-
4137
Install dependencies by running `pip install -r requirements/release.txt`,
42-
and optional build or development dependencies
38+
and optional build dependencies
4339
by running `pip install -r requirements/build.txt`
44-
or `pip install -r requirements/build.txt`.
40+
or `pip install -r requirements/build_windows.txt`.
4541

4642
Install Hug itself with `pip install .` or `pip install -e .` (for editable mode).
4743
This will compile all modules with [Cython](https://cython.org/) if it's installed in the environment.

0 commit comments

Comments
 (0)