README.md

# Quadcopter Section

This `quad/` directory contains all code that programs the quadcopter,
including 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.

The main quad application is written as a library, and located at:
```
src/quad_app (main function in quad_app.c)
```

The main XSDK project that actually runs on the Zybo is located at:
```
xsdk_workspace/real_quad
```

If you were wondering, we do have the complementary virtual quad easy testing:
```
src/virt_quad
```

## Building our Libraries

To build the libraries:
```
make libs
```

You can also build each library individually inside their respective project
directories:
```
cd src/<project> && make
```

## Testing

We have split our code into 2 main sections: application code and hardware code.
We did that so that we can write tests that run automatically on CI. You just
can't run automatic tests on hardware code because the environments won't match.

All CI tests are run using the following target:
```
make test
```

This incorporates unit tests (`src/<library>/test`), as well as a few functional
test scripts (`scripts/tests`) that verify things on the virtual quad.

You can also run the tests for a specific library inside its respective project
directory:
```
cd src/<project> && make test
```

### XSDK Project

We have tests for the hardware-level code, they just have to be run manually.
You can find these tests along with instructions at
`xsdk_workspace/read_quad/src/hw_impl_zybo_tests.c`