Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New API Doc start page #111

Merged
merged 1 commit into from
Nov 29, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ fp-info-cache
*.sch-bak
.DS_Store
~*.*
doxyHtml
Binary file added images/Logo/open_hornet_horizontal_500x79.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
60 changes: 57 additions & 3 deletions software/mainpage.markdown
Original file line number Diff line number Diff line change
@@ -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/)