From ac6e30f9b48bab667933bff96151dca553b3ead5 Mon Sep 17 00:00:00 2001 From: francium Date: Sat, 23 Dec 2023 14:51:12 -0500 Subject: [PATCH] docs: update readme --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3fac3bd..9f0888b 100644 --- a/README.md +++ b/README.md @@ -421,16 +421,19 @@ instead. ## Contributing -These steps should work on a Unix-based system (Linux, macOS, etc). On Windows, -you will need to refer to the Python documentation (linked below) and reference -the `Makefile` for commands to run from the non-unix shell you're using on -Windows. +These steps should work on any Unix-based system (Linux, macOS, etc) with Python +and `make` installed. On Windows, you will need to refer to the Python +documentation (linked below) and reference the `Makefile` for commands to run +from the non-unix shell you're using on Windows. 1. Setup and activate a virtual environment. See [Python docs][pydocs-venv] for more information about virtual environments and setup. -2. With the Run `make install` +2. Run `make install` to install dependencies 3. Switch to a new git branch and make your changes -4. Test your changes: `make test` and `make lint` +4. Test your changes: + - `make test` + - `make lint` + - You can also start a Python REPL and import `result` 5. Git commit and create a new PR. [pydocs-venv]: https://docs.python.org/3/library/venv.html