diff --git a/README.md b/README.md index 249d9bd..076b3f8 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,21 @@ # SatNOGS Rotator Controller -Firmware and electronics for SatNOGS Rotator. +Firmware and electronics designs for [SatNOGS Rotator](https://github.com/satnogs/satnogs-rotator/). -Repository includes all needed gerber files for PCB's and firmware for microcontroller. +Repository includes all source files for PCB's and firmware for the SatNOGS rotator controller assembly. -For previous versions check branches and tags. +## Documentation -More information can be found in our documentation. +More information can be found in our [documentation](http://satnogs.org/documentation/hardware/), or our [wiki](https://wiki.satnogs.org). + +Please check the documentation to find which release of the rotator controller matches your mechanical rotator version. + +## Repository policy +SatNOGS hardware repositories only track source design files. All needed derivative files (e.g. stl, grb etc) for production are created per release, packaged in an archive and uploaded linked to a [release](https://github.com/satnogs/satnogs-rotator-controller/releases). + +Each major release (x.0.0) is branched out of master. Subsequent fixes (minor or not) are commited on those branches and tagged accordingly. + +Master branch is most times under active development, so expect things to break. For production ready and previous releases source files check tags and branches. ## License