Skip to content

Commit b6ddaf0

Browse files
felixdivohardbyte
authored andcommitted
Added getting started section to README.rst
1 parent 387b586 commit b6ddaf0

2 files changed

Lines changed: 9 additions & 4 deletions

File tree

README.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,8 @@ questions and answers tagged with ``python+can``.
4646

4747
Wherever we interact, we strive to follow the
4848
`Python Community Code of Conduct <https://www.python.org/psf/codeofconduct/>`__.
49+
50+
Contributing
51+
------------
52+
53+
See `doc/development.rst` for getting started.

doc/development.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ https://github.com/hardbyte/python-can
1212
Building & Installing
1313
---------------------
1414

15-
This assumes that the commands are executed from the root of the repository.
15+
This assumes that the commands are executed from the root of the repository:
1616

17-
The project can be built and installed with ``python setup.py build`` and
17+
- The project can be built and installed with ``python setup.py build`` and
1818
``python setup.py install``.
19-
The unit tests can be run with ``python setup.py test``.
20-
The docs can be built with ``sphinx-build doc/ doc/_build``.
19+
- The unit tests can be run with ``python setup.py test``. The tests can be run with `python2` and `python3` to check with both major python versions, if they are installed.
20+
- The docs can be built with ``sphinx-build doc/ doc/_build``.
2121

2222

2323
Creating a Release

0 commit comments

Comments
 (0)