Skip to content

Commit 8ab3213

Browse files
authored
Add nightly PWA link to the README (#742)
1 parent c320de6 commit 8ab3213

File tree

1 file changed

+21
-15
lines changed

1 file changed

+21
-15
lines changed

README.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,19 @@ Current blackbox explorer version is built as
1919
Meaning it can work in both online and offline modes as regular desktop app
2020
would.
2121

22-
### Web
22+
### Latest stable version
2323

24-
1. Visit https://blackbox.betaflight.com/
25-
2. Use the app
24+
For the latest stable released version visit https://blackbox.betaflight.com/
2625

27-
### Standalone
26+
### Unstable testing versions
2827

29-
1. Visit https://blackbox.betaflight.com/
30-
2. Follow the procedure to install PWA on your platform. On MacOS chrome:
28+
The latest master build is always available at https://master.dev.blackbox.betaflight.com/
29+
30+
**Be aware that these versions are intended for testing / feedback only, and may be buggy or broken. Caution is advised when using these versions.**
31+
32+
### Install the app to be used in offline mode
33+
34+
Follow the procedure to install PWA on your platform. For example on MacOS chrome:
3135
![Url bar PWA install](screenshots/url-bar.webp)
3236
![PWA install dialog](screenshots/pwa-install-dialog.webp)
3337

@@ -64,7 +68,7 @@ performance.
6468
### Node setup
6569

6670
We are using [nvm](https://github.com/nvm-sh/nvm) to manage the correct node
67-
vesion, follow the install instruction there. After which from blackbox directory
71+
vesion, follow the install instructions there. After which from blackbox directory
6872
just run:
6973

7074
```bash
@@ -74,7 +78,7 @@ nvm use
7478
### Yarn
7579

7680
For dependency management we are using [yarn](https://yarnpkg.com/), follow the
77-
instruction there to install it.
81+
instructions there to install it.
7882

7983
### Development mode
8084

@@ -87,24 +91,26 @@ With `node` and `yarn` setup, to start developing run:
8791
yarn start
8892
```
8993

90-
This will start development server on http://localhost:5173/.
94+
This will start development server and the Blackbox will be available on http://localhost:5173/.
9195

92-
## Installing Dev Build locally
96+
### Installing development build locally
9397

9498
If you want to have latest and greatest version installed on your machine from
9599
the tip of the repository:
96-
1. First need to build the application:
100+
101+
First need to build the application:
97102
```bash
98103
yarn build
99104
```
100-
2. Start the application in `preview` mode
105+
Then start the application in `preview` mode
101106
```bash
102107
yarn preview
103108
```
104-
3. Visit http://localhost:4173/
105-
4. Follow the steps from [Standalone](#standalone)
109+
Visit http://localhost:4173/ and follow the steps from [Install the app to be used in offline mode](#install-the-app-to-be-used-in-offline-mode)
110+
111+
## Common problems
106112

107-
## Flight video won't load, or jumpy flight video upon export
113+
### Flight video won't load, or jumpy flight video upon export
108114

109115
Some flight video formats aren't supported by Chrome, so the viewer can't open
110116
them. You can fix this by re-encoding your video using the free tool

0 commit comments

Comments
 (0)