Skip to content

Commit 1c0893a

Browse files
committed
docs: edit README for conciseness.
1 parent 5e8fa25 commit 1c0893a

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,22 @@ Live demo: https://jpadgett314.github.io/led-matrix-vocab
88

99
## Installation
1010

11-
This app can be saved to your desktop, enabling offline use. An install button will appear in the address bar or browser menu, if your browser supports Progressive Web Apps (all modern browsers).
11+
This app can be saved to your desktop! See [instructions](https://www.installpwa.com/from/jpadgett314.github.io%2Fled-matrix-vocab).
1212

13-
Having trouble? See [Installation Instructions](https://www.installpwa.com/from/jpadgett314.github.io%2Fled-matrix-vocab).
14-
15-
There is no need to flash firmware. Default firmware is expected.
13+
There is no need to flash firmware. [Default firmware](https://github.com/FrameworkComputer/inputmodule-rs/releases) is expected.
1614

1715
> [!NOTE]
1816
> This app uses the Web Serial API, which is only supported on Chromium-based browsers.
1917
2018
## Development
2119

22-
This project features a minimalist development workflow. There is currently no bundler; in fact, there is no build. The source code is served directly from the `public` directory.
23-
24-
Due to the use of ECMAScript modules, a web server is required. Options include:
20+
There is no bundler, no build. The source code is served directly from the `public` directory.
2521

26-
1. Use the [Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) VSCode extension.
27-
2. From the `public` directory, invoke python's built-in module: `python3 -m http.server`
22+
However, a web server is required. Options include:
2823

29-
By default, this puts up the site on `http://127.0.0.1:5500/` (Live Server) `http://127.0.0.1:8000` (http.server).
24+
1. Use Yarn: `yarn install`, `yarn serve`.
25+
2. Use [Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) VSCode extension.
26+
3. From the `public` directory, invoke python's built-in module: `python3 -m http.server`
3027

3128
## Contributing
3229

0 commit comments

Comments
 (0)