Renamed doc to docs and updated README with rst.

This commit is contained in:
ShawnHymel 2018-12-08 16:58:51 -06:00
parent 9d6d94b5f5
commit 7d6ceeac56
4 changed files with 3 additions and 2 deletions

View File

@ -46,11 +46,12 @@ You will need the following components:
Connect the components as shown to your board.
![Test jig Fritzing diagram](doc/test_jig.png)
.. image:: docs/test_jig.png
:alt: Test jig Fritzing diagram
Copy the *lib* folder to the CIRCUITPYTHON drive. Copy *main.py* to the root directory of your CIRCUITPYTHON drive. Open a Serial terminal and connect to the board. Follow the directions given to run through the tests.
Building
========
Individual test modules can be built with the mpy-cross cross-compiler. This is required to save RAM space if you plan to run more than one test at a time. See [the mpy-cross directory in circuitpython](https://github.com/adafruit/circuitpython/tree/master/mpy-cross) to learn more.
Individual test modules can be built with the mpy-cross cross-compiler. This is required to save RAM space if you plan to run more than one test at a time. See `the mpy-cross directory in circuitpython <https://github.com/adafruit/circuitpython/tree/master/mpy-cross>`_ to learn more.

View File

Before

Width:  |  Height:  |  Size: 164 KiB

After

Width:  |  Height:  |  Size: 164 KiB

View File

Before

Width:  |  Height:  |  Size: 146 KiB

After

Width:  |  Height:  |  Size: 146 KiB