Skip to content
Snippets Groups Projects
Commit 5cbd0f73 authored by bbartels's avatar bbartels
Browse files

documentation: Update README.md

parent 730b3230
No related branches found
No related tags found
No related merge requests found
......@@ -21,11 +21,9 @@ src/virt_quad/
## Building
### Libraries
To build the libraries:
```
make libs
make
```
You can also build each library individually inside their respective project
......@@ -34,38 +32,25 @@ directories:
cd src/<project> && make
```
### XSDK Project
To build the XSDK project that runs on the Zybo (only works on co3050):
```
make zybo
```
To build the Zybo boot image for the SD card (only works on co3050):
```
make boot
```
Disclaimer: The make boot target currently does not work
## Testing
### Libraries
_Write tests! It makes automating things so much easier._
We try to write unit tests for the libraries we've written, since they are
not tied to the Zybo platform and are able to be run in our CI environment.
Run the unit and functional tests:
```
make test
```
You can also run the test for specific library inside its respective project
You can also run the test for a specific library inside its respective project
directory:
```
cd src/<project> && make test
```
### XSDK Project
### Manually 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.
The XSDK project implements the hardware interfaces used in the quad app.
There are tests can be executed from the main function in that XSDK project.
These tests essentially test each hardware interface.
Look in `xsdk_workspace/real_quad/src/hw_impl_zybo_tests.c` for instructions.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment