diff --git a/quad/README.md b/quad/README.md index 0bb5211ab278de7b4f7026b9aeb32fe1a70c9096..d0ee1d85a6a4844407a22910934f8e4df6893b56 100644 --- a/quad/README.md +++ b/quad/README.md @@ -1,6 +1,6 @@ # Quadcopter -The quad/ directory contains all code that programs the quadcopter. This +The `quad/` directory contains all code that programs the quadcopter. This includes any C libraries we have written, any HDL to program the Zybo on the quad, and the XSDK main project that runs on the Zybo. @@ -32,6 +32,14 @@ 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": +``` +source /opt/Xilinx/14.7/ISE_DS/settings64.sh +xsdk & +``` + ## Testing _Write tests! It makes automating things so much easier._ @@ -50,7 +58,8 @@ cd src/<project> && make test ### Manually testing the hardware interface Of course, we cannot run our automated tests on code that needs the Zybo. But -we have still written manual tests that you can use to test each specific -driver in the hardware interface. +we have manual tests that you can use to test each specific driver in the +hardware interface. Look in `xsdk_workspace/real_quad/src/hw_impl_zybo_tests.c` for instructions. +Ideally, you would run these tests from the XSDK IDE.