Skip to content

Commit

Permalink
edited documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelmbiya committed Nov 5, 2020
1 parent 57fcdc7 commit 6272af4
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 46 deletions.
12 changes: 5 additions & 7 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
=======
Credits
Credits and Acknowledgements
=======

Development Lead
----------------

* EEE3097S Group 19 <samuel.mbiya1@gmail.com>
This API made use of [Mario Gómez'](https://github.com/mxgxw) class to interface with the NFC reader Module MFRC522 on the Raspberry Pi. It can be found [here](https://github.com/mxgxw/MFRC522-python)

Contributors
------------

None yet. Why not be the first?
* EEE3097S Group 19:
[@IviweMalotana](https://github.com/IviweMalotana)
[@SKMBiya](https://github.com/SKMbiya)
31 changes: 1 addition & 30 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,16 +76,7 @@ Ready to contribute? Here's how to set up `rc522_iot` for local development.

Now you can make your changes locally.

5. When you're done making changes, check that your changes pass flake8 and the
tests, including testing other Python versions with tox::

$ flake8 rc522_iot tests
$ python setup.py test or pytest
$ tox

To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub::
5. Commit your changes and push your branch to GitHub::

$ git add .
$ git commit -m "Your detailed description of your changes."
Expand All @@ -106,23 +97,3 @@ Before you submit a pull request, check that it meets these guidelines:
https://travis-ci.com/SKMbiya/rc522_iot/pull_requests
and make sure that the tests pass for all supported Python versions.

Tips
----

To run a subset of tests::


$ python -m unittest tests.test_rc522_iot

Deploying
---------

A reminder for the maintainers on how to deploy.
Make sure all your changes are committed (including an entry in HISTORY.rst).
Then run::

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.
8 changes: 0 additions & 8 deletions HISTORY.rst

This file was deleted.

14 changes: 13 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,15 @@ rc522-iot



An API that allows you to interface with the mfrc522 RFID card reader
A python wrapper API that allows you to interface with the mfrc522 RFID card reader


* Free software: MIT license
* Documentation: https://rc522-iot.readthedocs.io.

Requirements
--------
The code requires you to have the mfrc522 library installed from the following command ```sudo pip3 install mfrc522```

Features
--------
Expand All @@ -35,3 +38,12 @@ This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypack

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


This API made use of [Mario Gómez'](https://github.com/mxgxw) class to interface with the NFC reader Module MFRC522 on the Raspberry Pi. It can be found [here](https://github.com/mxgxw/MFRC522-python)

Contributors
------------
* EEE3097S Group 19:
[@IviweMalotana](https://github.com/IviweMalotana)
[@SKMBiya](https://github.com/SKMbiya)

0 comments on commit 6272af4

Please sign in to comment.