diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..0207b4b41e536bcf55598d29b6faf0edb27c6507 --- /dev/null +++ b/README.en.md @@ -0,0 +1,43 @@ +# XPilot + +A lightweight, modular autopilot system for UAS (Unmanned Aerial Systems). + +## Overview + +XPilot is an open-source autopilot platform designed for small unmanned aircraft systems. It provides core flight control capabilities with a modular architecture that allows for easy customization and extension. + +## Features + +- Modular flight control system +- Support for multiple aircraft configurations +- Mission planning and execution +- Real-time telemetry +- Safety mechanisms and fail-safes + +## Installation + +```bash +# Clone the repository +git clone https://gitee.com/openuas/xpilot.git +cd xpilot + +# Build the project +mkdir build && cd build +cmake .. +make + +# Install +sudo make install +``` + +## Usage + +For detailed usage instructions, please refer to the documentation in the `docs/` directory. + +## Contributing + +Contributions are welcome! Please read our contributing guidelines before submitting pull requests. + +## License + +This project is licensed under the terms included in the LICENSE file. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..09fccf0fb88603f06c410a4b5a3fd360fd113e48 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ + + +# XPilot + +A lightweight, modular autopilot system for UAS (Unmanned Aerial Systems). + +## Overview + +XPilot is an open-source autopilot platform designed for small unmanned aircraft systems. It provides core flight control capabilities with a modular architecture that allows for easy customization and extension. + +## Features + +- Modular flight control system +- Support for multiple aircraft configurations +- Mission planning and execution +- Real-time telemetry +- Safety mechanisms and fail-safes + +## Installation + +```bash +# Clone the repository +git clone https://gitee.com/openuas/xpilot.git +cd xpilot + +# Build the project +mkdir build && cd build +cmake .. +make + +# Install +sudo make install +``` + +## Usage + +For detailed usage instructions, please refer to the documentation in the `docs/` directory. + +## Contributing + +Contributions are welcome! Please read our contributing guidelines before submitting pull requests. + +## License + +This project is licensed under the terms included in the LICENSE file. \ No newline at end of file