diff --git a/quad/README.md b/quad/README.md index 6becead2fe878e1c49e091c8ff7a9db6fe50dca7..a2971358fbdc726681e2c33ea66befe8c45d3564 100644 --- a/quad/README.md +++ b/quad/README.md @@ -16,7 +16,9 @@ implementation the "virtual quad". This is done in `src/virt_quad`. ## Building -To build the libraries: +### Primarily Libraries and Executables + +To build the libraries and executables: ``` make ``` @@ -27,9 +29,13 @@ directories: cd src/<project> && make ``` -To build the XSDK project, use the XSDK IDE. Source the proper XSDK files, and -then start up the XSDK IDE. Be sure to select the `xsdk_workspace` directory -in the quad directory as your "workspace": +**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) +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 @@ -41,6 +47,9 @@ Run the unit and functional tests: 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 Of course, we cannot run automated tests on code that needs the Zybo. But