diff --git a/.gitignore b/.gitignore index 40dd33b7f..6365aaa59 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ fp-info-cache *.sch-bak .DS_Store ~*.* +doxyHtml diff --git a/images/Logo/open_hornet_horizontal_500x79.png b/images/Logo/open_hornet_horizontal_500x79.png new file mode 100644 index 000000000..2a925f91f Binary files /dev/null and b/images/Logo/open_hornet_horizontal_500x79.png differ diff --git a/software/mainpage.markdown b/software/mainpage.markdown index 0c1a7552c..87e8e12d1 100644 --- a/software/mainpage.markdown +++ b/software/mainpage.markdown @@ -1,4 +1,58 @@ -API Documentation -============ +# OpenHornet API Documentation -This is the OpenHornet API Documentation main page. + +![OH logo](https://raw.githubusercontent.com/jrsteensen/OpenHornet/master/images/Logo/open_hornet_horizontal_500x79.png) + +The OpenHornet Project is a F/A-18C OFP 13C Lot 20 1:1 Replica Simulator, consisting of a physical structure and electrical/software interfaces to a PC to be driven by Digital Combat Simulator (DCS). + + +## Documentation + +This is the API documentation of the OpenHornet Software. You will find a documentation of all the Files, Classes and Functions of the OpenHornet Software here. The documentation was generated using Doxygen. For more information and documentation, visit the links below. + +## Current Software State + +| Repo | State | +|:----------|:----------| +| Sandbox | ![Build Status](https://travis-ci.org/balzreber/OpenHornetSandbox.svg?branch=software) | +| Main Repo | ![Build Status](https://travis-ci.org/jrsteensen/OpenHornet.svg?branch=software) | + + +## Links + + +* [OpenHornet Website](https://www.openhornet.com) +* [OpenHornet main git repo](https://github.com/jrsteensen/OpenHornet) +* [OpenHornet Discord](https://discord.gg/G5PA5ju) +* [Donate to OpenHornet](https://www.openhornet.com/campaigns/donate/) + + +## Licensing +This Project is released under the +**Creative Commons - Atribution - Non Comercal - Share Alike** +license. + +**CC BY-NC-SA 3.0** + +### You are free to: + +- Share — copy and redistribute the material in any medium or format +- Adapt — remix, transform, and build upon the material + +The licensor cannot revoke these freedoms as long as you follow the license terms. + + +### Under the following terms: + +- Attribution — You must give appropriate credit, provide a link to the license, + and indicate if changes were made. You may do so in any reasonable manner, + but not in any way that suggests the licensor endorses you or your use. +- NonCommercial — You may not use the material for commercial purposes. +- ShareAlike — If you remix, transform, or build upon the material, + you must distribute your contributions under the same license as the original. + +No additional restrictions — You may not apply legal terms or technological +measures that legally restrict others from doing anything the license permits. + +More Information about the license can be found under: +[Creative Commons BY-NC-SA 3.0](https://creativecommons.org/licenses/by-nc-sa/3.0/)