Updated README.rst to include how to do the setup #555
Conversation
Codecov Report
@@ Coverage Diff @@
## main #555 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 6 6
Lines 357 357
Branches 29 29
=========================================
Hits 357 357
Flags with carried forward coverage won't be shown. Click here to find out more. |
README.rst
Outdated
|
|
||
| Requires Python 3.6+ | ||
|
|
||
| ``` |
There was a problem hiding this comment.
This file uses rst instead of MarkDown. See https://devguide.python.org/documenting/#showing-code-examples
There was a problem hiding this comment.
@ezio-melotti can I use shell? for the codeblock?
.. code-block:: shell
There was a problem hiding this comment.
https://pygments.org/docs/lexers/#lexers-for-various-shells shell is accepted, otherwise you can use bash or sh too. See also the .. highlight:: directive as suggested in the review.
Yes, I've signed the CLA ;-) |
There was a problem hiding this comment.
The markup looks good now. You could set the highlight language too, but it's not essential.
I'll let @Mariatta double-check if the content is correct and merge the PR.
Hi @ezio-melotti Thanks for the review! |
Co-authored-by: Ezio Melotti <[email protected]>
| Create virtual environment and activate it:: | ||
|
|
||
| $ python3 -m venv venv | ||
| $ source venv/bin/activate |
There was a problem hiding this comment.
This assumes a unix environment and won't work for Windows I think. Is that an issue?
| Requires Python 3.6+ | ||
|
|
There was a problem hiding this comment.
Let's not repeat this info from line 15:
| Requires Python 3.6+ |
It's probably out of date: since #657 we only test 3.11+ so should match that.
|
|
||
| Requires Python 3.6+ | ||
|
|
||
| Create virtual environment and activate it:: |
There was a problem hiding this comment.
Since #620, we have a tox.ini config, so we can replace the venv setup, dependency installation and pytest call with installing and running tox.
| Setup Info | ||
| ========== |
There was a problem hiding this comment.
This section is really about running tests, let's name it to reflect this.
Hi there,
I was wondering if adding this information will be helpful. Esp. for beginners.