This commit is contained in:
2022-05-16 23:45:21 +02:00
2 changed files with 28 additions and 8 deletions

21
LICENSE.md Normal file
View File

@@ -0,0 +1,21 @@
# MIT License
Copyright (c) 2022 [Lino Schmidt](https://github.com/LinoSchmidt)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@@ -2,20 +2,19 @@
A 3D Sticks Exporter for EdgeTX/OpenTX logs. A 3D Sticks Exporter for EdgeTX/OpenTX logs.
Setup: ## Setup:
------
- Download [Blender (Portable)](https://www.blender.org/download) and unpack it with the name `blender` in the folder `<Project folder>/assets`. - Download [Blender (Portable)](https://www.blender.org/download) and unpack it with the name `blender` in the folder `<Project folder>/assets`.
- Start a console in the project folder and execute the command `npm install` to install the necessary packages. - Start a console in the project folder and execute the command `npm install` to install the necessary packages.
Test: ## Test:
------
To test the program, execute the command `npm start` in the project folder. To test the program, execute the command `npm start` in the project folder.
Build (Windows): ## Build:
------
### Windows:
To build the program, execute the command `npm run package-win` in the project folder. To build the program, execute the command `npm run package-win` in the project folder.
After that, open the file `installer-builder.iss` with the program [Inno Setup Compiler](https://jrsoftware.org/isdl.php#stable) and compile it. After that, open the file `installer-builder.iss` with the program [Inno Setup Compiler](https://jrsoftware.org/isdl.php#stable) and compile it.
The finished installer should be inside `<Project Folder>/output`. The finished installer should be inside `<Project Folder>/output`.
## Licence:
Copyright © 2022 Lino Schmidt. All rights reserved. his project is released under the MIT license, for more information, check the [LICENSE](LICENSE.md) file.