Skip to content

Commit

Permalink
Merge pull request #253 from Rotzbua/patch-1
Browse files Browse the repository at this point in the history
Extend Readme by Forks who made diffrent ports
  • Loading branch information
Rotzbua authored Oct 14, 2016
2 parents 8ef6b90 + 19063a3 commit c6a341f
Showing 1 changed file with 27 additions and 5 deletions.
32 changes: 27 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,13 @@ Read and write different types of Radio-Frequency IDentification (RFID) cards
on your Arduino using a RC522 based reader connected via the Serial Peripheral
Interface (SPI) interface.


.. _development:
Development
----------
**The development by owner miguelbalboa has ended**. Further development will be done by community. This library is still maintained by miguelbalboa, so make pull request if you like some new features or fixes. Support/issues should be solved by community.


.. _what works and not:
What works and not?
----------
Expand Down Expand Up @@ -58,10 +60,29 @@ If you use your own compiler, you have to enable ``c++11``-support.
Compatible boards
----------

This library is compatible to Teensy and ESP8266, but not all examples are available for every board. Also you have to change pins, see `pin layout`_.
**!!!Only for advanced user!!!**

This library is compatible to Teensy and ESP8266, if you use board plugin of the Arduino IDE. Not all examples are available for every board. You also have to change pins, see `pin layout`_.

Some user made some patches/suggestions/ports for other boards:

* Linux: https://github.com/miguelbalboa/rfid/pull/216
* chipKIT: https://github.com/miguelbalboa/rfid/pull/230
* ESP8266 (native): https://github.com/miguelbalboa/rfid/pull/235

Note that the main target/support of library is still Arduino.

.. _support issue:
Support/issue
----------
1. First checkout `what works and not`_ and `troubleshooting`_ .

2. It seems to be a hardware issue or you need support to program your project?
Please ask in the official `Arduino forum`_, there you would get a much faster answer then on github.

3. It seems to be a software issue?
Open an issue on github.


.. _pin layout:
Pin Layout
Expand Down Expand Up @@ -224,7 +245,7 @@ OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to http://unlicense.org/
For more information, please refer to https://unlicense.org/


History
Expand All @@ -241,9 +262,10 @@ It has been extended with functionality to alter sector 0 on Chinese UID changea


.. _arduino: https://arduino.cc/
.. _ebay: http://www.ebay.com/
.. _ebay: https://www.ebay.com/
.. _iso/iec 14443a: https://en.wikipedia.org/wiki/ISO/IEC_14443
.. _iso/iec 14443-3\:2011 part 3:
.. _nxp mfrc522: http://www.nxp.com/documents/data_sheet/MFRC522.pdf
.. _broken: http://eprint.iacr.org/2008/166
.. _nxp mfrc522: https://www.nxp.com/documents/data_sheet/MFRC522.pdf
.. _broken: https://eprint.iacr.org/2008/166
.. _supported by hardware: https://web.archive.org/web/20151210045625/http://www.nxp.com/documents/leaflet/939775017564.pdf
.. _Arduino forum: https://forum.arduino.cc

0 comments on commit c6a341f

Please sign in to comment.