From fd02ed55db213e838f4573a338c29fbe10b0a933 Mon Sep 17 00:00:00 2001
From: bbartels <bbartels@iastate.edu>
Date: Mon, 1 May 2017 19:33:25 -0500
Subject: [PATCH] Update README.md

---
 quad/README.md | 28 +++++++++++-----------------
 1 file changed, 11 insertions(+), 17 deletions(-)

diff --git a/quad/README.md b/quad/README.md
index e3376f886..dae356a0b 100644
--- a/quad/README.md
+++ b/quad/README.md
@@ -4,20 +4,15 @@ 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.
 
-## Documents
-[Zybo Pinout Assignments](doc/zybo_pinout_assignments.md)  
-[How to use Xilinx software tools](doc/how_to_use_xilinx_tools.pdf)  
-
 ## Brief Intro
 
-The main quad application is written as a library, and located at 
-`src/quad_app/` ("main" function in quad_app.c).
+The main quad application is located at `src/quad_app/`.
 
-The main XSDK project that actually runs on the Zybo is located at
-`xsdk_workspace/real_quad/`
+To run this application on the Zybo, we need to implement the hardware drivers,
+and provide a `main function`. This is done in `xsdk_workspace/real_quad/src`.
 
-We also have a complemetary "virtual quad" to ease testing located at
-`src/virt_quad/`
+We can also run this application on our own laptops for testing. We call this
+implementation the "virtual quad". This is done in `src/virt_quad`.
 
 ## Building
 
@@ -38,6 +33,7 @@ in the quad directory as your "workspace":
 
 ## Testing
 
+### Automated Tests
 _Write tests! It makes automating things so much easier._
 
 Run the unit and functional tests:
@@ -45,21 +41,19 @@ Run the unit and functional tests:
 make test
 ```
 
-You can also run the test for a specific library inside its respective project
-directory:
-```
-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
+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 
 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.
 
+## Other Documents
+[Zybo Pinout Assignments](doc/zybo_pinout_assignments.md)  
+[How to use Xilinx software tools](doc/how_to_use_xilinx_tools.pdf)  
+
 ## XSDK FYIs
 Definitely first read the [Xilinx How-To](doc/how_to_use_xilinx_tools.pdf).
 
-- 
GitLab