diff --git a/README.md b/README.md index 7afaabf..cf972a3 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,16 @@ This library helps make writing firmware for the [Sitka Instruments Gravity](htt The latest releases of all Sitka Instruments Gravity firmware builds can be found on the [Updater](https://sitkainstruments.com/gravity/updater/) page. You can use this page to flash the latest build directly to the Arduino Nano on the back of your module. +## Project Code Layout + +* [`src/`](src/) - **libGravity**: This is the hardware abstraction library used to simplify the creation of new Gravity module firmware by providing common reusable wrappers around the module peripherials like [DigitalOutput](src/digital_output.h#L18) providing methods like [`Update(uint8_t state)`](src/digital_output.h#L45) which allow you to set that output channel voltage high or low, and common module behavior like [Clock](src/clock.h#L30) which provides handlers like [AttachExtHandler](src/clock.h#L69) which takes a callback function to handle external clock tick behavior when receiving clock trigger. + +* [`firmware/Gravity`](firmware/Gravity/) - **Alt Gravity**: This is the implementation of the default 6-channel trigger/gate clock modulation firmware. This is a full rewrite of the original firmware designed to use `libGravity` with a focus on open source friendlines. + +* `firmware/GridSeq` - **GridSeq**: Comming Soon. + +* [`examples/skeleton`](examples/skeleton/skeleton.ino) - **Skeleton**: This is the bare bones scaffloding for a `libGravity` firmware app. + ## Installation Download or git clone this repository into your Arduino > libraries folder. @@ -114,7 +124,7 @@ void UpdateDisplay() { } ``` -**Builing New Firmware Using libGravity** +**Building New Firmware Using libGravity** When starting a new firmware sketch you can use the [skeleton](examples/skeleton/skeleton.ino) app as a place to start. @@ -126,4 +136,4 @@ If you do not want to use the libGravity hardware abstraction library and want t ``` $ arduino-cli compile -v -b arduino:avr:nano ./firmware/Gravity/Gravity.ino -e --output-dir=./build/ -``` \ No newline at end of file +```