diff --git a/quad/README.md b/quad/README.md index a2971358fbdc726681e2c33ea66befe8c45d3564..7e29ed000c0bb3621c2b8f07403043484b710632 100644 --- a/quad/README.md +++ b/quad/README.md @@ -16,7 +16,7 @@ implementation the "virtual quad". This is done in `src/virt_quad`. ## Building -### Primarily Libraries and Executables +#### Primarily Libraries and Executables To build the libraries and executables: ``` @@ -32,14 +32,14 @@ cd src/<project> && make **NOTE**: All build artifacts will be placed in `quad/lib` or `quad/bin` (depending on whether it is a library or executable, respectively) -### XSDK Project (what runs on the Zybo) +#### XSDK Project (what runs on the Zybo) To build the XSDK project, use the XSDK IDE. Refer to the [Xilinx How-to](doc/how_to_use_xilinx_tools.pdf) for more instructions. Be sure to select the `xsdk_workspace` directory in the quad directory as your "workspace." ## Testing -### Automated Tests +#### Automated Tests _Write tests! It makes automating things so much easier._ Run the unit and functional tests: @@ -50,7 +50,7 @@ make test And glad to hear you are interested in writing your own unit tests! Look at the README and examples in our simple testing library at `src/test`. -### Manually testing the hardware interface +#### Manually testing the hardware interface Of course, we cannot run automated tests on code that needs the Zybo. But we have manual tests that you can use to test each specific driver in the