Commit 3ca00942 authored by Thomas Dowrick's avatar Thomas Dowrick

Issue #13: Update readme.rst

parent 0d25b91c
......@@ -27,15 +27,14 @@ Author: {{ cookiecutter.full_name }}
{{ cookiecutter.project_name }} supports Python 2.7 and Python 3.6.
Installing
----------
You can pip install directly from the repository as follows:
{{ cookiecutter.project_name }} is currently a demo project, which will add/multiply two numbers. Example usage:
::
pip install git+{{ cookiecutter.project_url }}
python {{cookiecutter.pkg_name}}.py 5 8
python {{cookiecutter.pkg_name}}.py 3 6 --multiply
Please explore the project structure, and implement your own functionality.
Developing
----------
......@@ -50,15 +49,36 @@ You can clone the repository using the following command:
git clone {{ cookiecutter.project_url }}
Running the tests
^^^^^^^^^^^^^^^^^
Running tests
^^^^^^^^^^^^^
Pytest is used for running unit tests:
::
pip install pytest
python -m pytest
Linting
^^^^^^^
This code conforms to the PEP8 standard. Pylint can be used to analyse the code:
::
pip install pylint
pylint --rcfile=tests/pylintrc {{cookiecutter.pkg_name}}
You can run the unit tests by installing and running tox:
Installing
----------
You can pip install directly from the repository as follows:
::
pip install tox
tox
pip install git+{{ cookiecutter.project_url }}
Contributing
^^^^^^^^^^^^
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment