Skip to content

Commit ac6e30f

Browse files
committed
docs: update readme
1 parent 355df7f commit ac6e30f

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -421,16 +421,19 @@ instead.
421421

422422
## Contributing
423423

424-
These steps should work on a Unix-based system (Linux, macOS, etc). On Windows,
425-
you will need to refer to the Python documentation (linked below) and reference
426-
the `Makefile` for commands to run from the non-unix shell you're using on
427-
Windows.
424+
These steps should work on any Unix-based system (Linux, macOS, etc) with Python
425+
and `make` installed. On Windows, you will need to refer to the Python
426+
documentation (linked below) and reference the `Makefile` for commands to run
427+
from the non-unix shell you're using on Windows.
428428

429429
1. Setup and activate a virtual environment. See [Python docs][pydocs-venv] for more
430430
information about virtual environments and setup.
431-
2. With the Run `make install`
431+
2. Run `make install` to install dependencies
432432
3. Switch to a new git branch and make your changes
433-
4. Test your changes: `make test` and `make lint`
433+
4. Test your changes:
434+
- `make test`
435+
- `make lint`
436+
- You can also start a Python REPL and import `result`
434437
5. Git commit and create a new PR.
435438

436439
[pydocs-venv]: https://docs.python.org/3/library/venv.html

0 commit comments

Comments
 (0)