Added build instructions

This commit is contained in:
2023-04-11 12:11:10 +02:00
parent b72a44fd3b
commit 1cf9ca8541

View File

@@ -2,7 +2,7 @@
StickExporterTX is a 3D Stick Exporter for EdgeTX/OpenTX logs. StickExporterTX is a 3D Stick Exporter for EdgeTX/OpenTX logs.
## Quick Start Guide ## Controller Setup Guide
To log your sticks on each model, go to `settings -> global functions` in your RC controller. To log your sticks on each model, go to `settings -> global functions` in your RC controller.
@@ -18,6 +18,17 @@ If you only want to set up logging for one model, go to `model -> special functi
![special-functions](readme/pictures/special-functions.bmp) ![special-functions](readme/pictures/special-functions.bmp)
## How to build (for developers)
The following software is required to build the project:
- [Node.js](https://nodejs.org/)
- [Python 3](https://www.python.org/)
To build the project, run the following commands in the project directory:
```bash
npm install
npm run bundle
```
If the commands were successful, a new folder called `dist` should have been created in the project directory containing the compiled files.
## Licence: ## Licence:
This project is released under the MIT license, for more information, check the [LICENSE](LICENSE) file. This project is released under the MIT license, for more information, check the [LICENSE](LICENSE) file.