Skip to content

Commit

Permalink
docs: added link to the tutorial to README.md and fixed usage sectino
Browse files Browse the repository at this point in the history
  • Loading branch information
matveypashkovskiy committed Dec 21, 2020
1 parent 42923ec commit 9d25edf
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@

### Usage as a module (no source code)

1. Add your public key to github profile
2. Add `git+ssh://git@github.com/F-Secure/pytest-rts.git#egg=pytest-rts` as a dependency to `requirements.txt`
3. Install dependencies
4. Use the tool with `pytest --rts`
1. Install the module with `pip install pytest-rts`
2. Use the tool with `pytest --rts`

More detailed usage is described in the [tutorial][tutorial]

### Usage from source code

Expand Down Expand Up @@ -50,6 +50,7 @@ Read through our [contributing guidelines][contributing] to learn about our subm

Help us keep the project open and inclusive. Please read and follow our [Code of Conduct][codeofconduct].

[tutorial]: https://github.com/F-Secure/pytest-rts/tree/master/docs/tutorial.md
[developer]: https://github.com/F-Secure/pytest-rts/tree/master/docs/DEVELOPER.md
[contributing]: https://github.com/F-Secure/pytest-rts/tree/master/docs/CONTRIBUTING.md
[codeofconduct]: https://github.com/F-Secure/pytest-rts/tree/master/docs/CODE_OF_CONDUCT.md

0 comments on commit 9d25edf

Please sign in to comment.