xplane11-sys

git clone git://archive.git.mtrnord.blog/MTRNord/xplane11-sys.git
Log | Files | Refs | README | LICENSE

README.md (4379B)

      1 <!--
      2 *** Thanks for checking out this README Template. If you have a suggestion that would
      3 *** make this better, please fork the repo and create a pull request or simply open
      4 *** an issue with the tag "enhancement".
      5 *** Thanks again! Now go create something AMAZING! :D
      6 ***
      7 ***
      8 ***
      9 *** To avoid retyping too much info. Do a search and replace for the following:
     10 *** github_username, repo_name, twitter_handle, email
     11 -->
     12 
     13 
     14 
     15 
     16 
     17 <!-- PROJECT SHIELDS -->
     18 <!--
     19 *** I'm using markdown "reference style" links for readability.
     20 *** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
     21 *** See the bottom of this document for the declaration of the reference variables
     22 *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
     23 *** https://www.markdownguide.org/basic-syntax/#reference-style-links
     24 -->
     25 [![Contributors][contributors-shield]][contributors-url]
     26 [![Forks][forks-shield]][forks-url]
     27 [![Stargazers][stars-shield]][stars-url]
     28 [![Issues][issues-shield]][issues-url]
     29 [![MIT License][license-shield]][license-url]
     30 
     31 
     32 
     33 <!-- PROJECT LOGO -->
     34 <br />
     35 <p align="center">
     36   <h3 align="center">XPlane 11 SDK Bindings</h3>
     37 
     38   <p align="center">
     39     Rust bindings for the <a href="https://developer.x-plane.com/sdk/">Xplane 11 SDK</a>
     40     <br />
     41     <a href="https://github.com/MTRNord/xplane11-sys"><strong>Explore the docs »</strong></a>
     42     <br />
     43     <br />
     44     <a href="https://github.com/MTRNord/xplane11-sys">View Demo</a>
     45     ·
     46     <a href="https://github.com/MTRNord/xplane11-sys/issues">Report Bug</a>
     47     ·
     48     <a href="https://github.com/MTRNord/xplane11-sys/issues">Request Feature</a>
     49   </p>
     50 </p>
     51 
     52 
     53 
     54 <!-- TABLE OF CONTENTS -->
     55 ## Table of Contents
     56 
     57 * [About the Project](#about-the-project)
     58   * [Built With](#built-with)
     59 * [Getting Started](#getting-started)
     60 * [Roadmap](#roadmap)
     61 * [Contributing](#contributing)
     62 * [License](#license)
     63 * [Contact](#contact)
     64 * [Acknowledgements](#acknowledgements)
     65 
     66 
     67 
     68 <!-- ABOUT THE PROJECT -->
     69 ## About The Project
     70 
     71 ### Built With
     72 
     73 * [Rust](https://www.rust-lang.org/)
     74 * [Rust-Bindgen](https://github.com/rust-lang/rust-bindgen)
     75 * [Xplane11 SDK](https://developer.x-plane.com/sdk/)
     76 
     77 
     78 
     79 <!-- GETTING STARTED -->
     80 ## Getting Started
     81 
     82 TODO: Link to example repo
     83 
     84 
     85 
     86 <!-- ROADMAP -->
     87 ## Roadmap
     88 
     89 See the [open issues](https://github.com/MTRNord/xplane11-sys/issues) for a list of proposed features (and known issues).
     90 
     91 
     92 
     93 <!-- CONTRIBUTING -->
     94 ## Contributing
     95 
     96 Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
     97 
     98 1. Fork the Project
     99 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
    100 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
    101 4. Push to the Branch (`git push origin feature/AmazingFeature`)
    102 5. Open a Pull Request
    103 
    104 
    105 
    106 <!-- LICENSE -->
    107 ## License
    108 
    109 Distributed under the Apache2 License. See `LICENSE` for more information.
    110 
    111 
    112 
    113 <!-- CONTACT -->
    114 ## Contact
    115 
    116 MTRNord - [@mtrnord](https://twitter.com/mtrnord) - [Xplane Forum](https://forums.x-plane.org/index.php?/profile/997689-mtrnord/) - [Matrix: @mtrnord:nordgedanken.dev](https://matrix.to/#/@mtrnord:nordgedanken.dev) - info[at]nordgedanken.de
    117 
    118 Project Link: [https://github.com/MTRNord/xplane11-sys](https://github.com/MTRNord/xplane11-sys)
    119 
    120 
    121 
    122 <!-- ACKNOWLEDGEMENTS -->
    123 ## Acknowledgements
    124 
    125 * Xplane Team
    126 * Rust Bindgen Team
    127 
    128 
    129 
    130 
    131 <!-- MARKDOWN LINKS & IMAGES -->
    132 <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
    133 [contributors-shield]: https://img.shields.io/github/contributors/MTRNord/xplane11-sys.svg?style=flat-square
    134 [contributors-url]: https://github.com/MTRNord/xplane11-sys/graphs/contributors
    135 [forks-shield]: https://img.shields.io/github/forks/MTRNord/xplane11-sys.svg?style=flat-square
    136 [forks-url]: https://github.com/MTRNord/xplane11-sys/network/members
    137 [stars-shield]: https://img.shields.io/github/stars/MTRNord/xplane11-sys.svg?style=flat-square
    138 [stars-url]: https://github.com/MTRNord/xplane11-sys/stargazers
    139 [issues-shield]: https://img.shields.io/github/issues/MTRNord/xplane11-sys.svg?style=flat-square
    140 [issues-url]: https://github.com/MTRNord/xplane11-sys/issues
    141 [license-shield]: https://img.shields.io/github/license/MTRNord/xplane11-sys.svg?style=flat-square
    142 [license-url]: https://github.com/MTRNord/xplane11-sys/blob/master/LICENSE.txt