Merge pull request #310 from iNavFlight/dzikuvx-readme-standalone-apps

Updated README for standalone installation for Win and Mac users
pull/313/head
Paweł Spychalski 7 years ago committed by GitHub
commit 216ff35b38
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -6,9 +6,31 @@ It runs as an app within Google Chrome and allows you to configure the INAV soft
Various types of aircraft are supported by the tool and by INAV, e.g. quadcopters, hexacopters, octocopters and fixed-wing aircraft. Various types of aircraft are supported by the tool and by INAV, e.g. quadcopters, hexacopters, octocopters and fixed-wing aircraft.
[![available in the Chrome web store](https://developer.chrome.com/webstore/images/ChromeWebStore_Badge_v2_206x58.png)](https://chrome.google.com/webstore/detail/inav-configurator/fmaidjmgkdkpafmbnmigkpdnpdhopgel) ## Installation
Depending on target operating system, _INAV Configurator_ is distributed as _standalone_ application or Chrome App.
### Windows
1. Visit [release page](https://github.com/iNavFlight/inav-configurator/releases)
1. Download Configurator for Windows platform (win32 or win64 is present)
1. Extract ZIP archive
1. Run INAV Configurator app from unpacked folder
1. Configurator is not signed, so you have to allow Windows to run untrusted application. There might be a monit for it during first run
### Mac
1. Visit [release page](https://github.com/iNavFlight/inav-configurator/releases)
1. Download Configurator for Mac platform
1. Extract ZIP archive
1. Run INAV Configurator
1. Configurator is not signed, so you have to allow Mac to run untrusted application. There might be a monit for it during first run
## Build system ### ChromeOS
**INAV Configurator** form ChromeOS is available in [Chrome Web Store](https://chrome.google.com/webstore/detail/inav-configurator/fmaidjmgkdkpafmbnmigkpdnpdhopgel)
### Building and running INAV Configurator locally (for development or Linux users)
For local development, **node.js** build system is used. For local development, **node.js** build system is used.
@ -39,26 +61,6 @@ INAV Configurator was originally a [fork](#credits) of Cleanflight Configurator
This configurator is the only configurator with support for INAV specific features. It will likely require that you run the latest firmware on the flight controller. This configurator is the only configurator with support for INAV specific features. It will likely require that you run the latest firmware on the flight controller.
If you are experiencing any problems please make sure you are running the [latest firmware version](https://github.com/iNavFlight/inav/releases). If you are experiencing any problems please make sure you are running the [latest firmware version](https://github.com/iNavFlight/inav/releases).
## Installation
### Via chrome webstore
1. Visit [Chrome web store](https://chrome.google.com/webstore/detail/inav-configurator/fmaidjmgkdkpafmbnmigkpdnpdhopgel)
2. Click **+ Free**
Please note - the application will automatically update itself when new versions are released. Please ensure you maintain configuration backups as described in the INAV documentation.
### Alternative way
1. Clone the repo to any local directory or download it as zip
2. Start Chromium or Google Chrome and go to tools -> extension
3. Check the "Developer mode" checkbox
4. Click on load unpacked extension and point it to the INAV Configurator directory (for example D:/inav-configurator)
## How to use
You can find the INAV Configurator icon in your application tab "Apps"
## Notes ## Notes
### WebGL ### WebGL
@ -72,9 +74,13 @@ Make sure Settings -> System -> "User hardware acceleration when available" is c
## Support ## Support
If you need help your please use the multiwii or rcgroups forums or visit the IRC channel before raising issues in the issue trackers. GitHub issue tracker is reserved for bugs and other technical problems. If you do not know how to setup
everything, hardware is not working or have any other _support_ problem, please consult:
* [rcgroups main thread](https://www.rcgroups.com/forums/showthread.php?2495732-Cleanflight-iNav-(navigation-rewrite)-project)
* [Slack channel](https://inavflight.signup.team/)
### Issue trackers ## Issue trackers
For INAV configurator issues raise them here For INAV configurator issues raise them here
@ -84,15 +90,6 @@ For INAV firmware issues raise them here
https://github.com/iNavFlight/inav/issues https://github.com/iNavFlight/inav/issues
## Technical details
This branch uses NW.js to pack Crome app into single package with node.js and chromium
```
npm install
./node_modules/nw-builder/bin/nwbuild -p win32 ./
```
## Developers ## Developers
We accept clean and reasonable patches, submit them! We accept clean and reasonable patches, submit them!

Loading…
Cancel
Save