diff --git a/README.md b/README.md index e144ed7..98daedc 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,11 @@ # FreeformAstronomyClock +[![License: GNU General Public License v3.0](https://img.shields.io/badge/Firmware%20License-GNU%20GPL--v3.0-yellow)](https://www.gnu.org/licenses/gpl-3.0.en.html#license-text) +[![License: CC BY-SA 4.0](https://img.shields.io/badge/Documentation%20License-CC_BY--SA_4.0-lightgrey)](https://creativecommons.org/licenses/by-sa/4.0/) + + +This repository contains all the files and documentation for Freeform Astronomy Clock, an Arduino powered astronomical clock which displays the Local Sidereal Time(LST) and lunar phase using the date, time and location data provided by a GPS-6MV2 module. [Visit the DIY guide](https://gorkem.cc/projects/AstroClock) for details. + + +File structure: ++ `Firmware` contains the code and necessary drivers. \ No newline at end of file