|
1 | 1 | # LED Matrix Vocab |
2 | 2 |
|
3 | | -Displays random Japanese words on a pair of Framework 16 LED matrix modules. |
| 3 | +Put your LED Matrix Modules to work and study Japanese vocabulary! |
4 | 4 |
|
5 | 5 | Live demo: https://jpadgett314.github.io/led-matrix-vocab |
6 | 6 |
|
7 | | -This app uses the Web Serial API, which is only supported on Chromium-based browsers. |
| 7 | + |
| 8 | + |
| 9 | +## Getting Started (User) |
| 10 | + |
| 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). |
| 12 | + |
| 13 | +Having trouble? See [Installation Instructions](https://www.installpwa.com/from/jpadgett314.github.io%2Fled-matrix-vocab). |
| 14 | + |
| 15 | +That's it! |
| 16 | + |
| 17 | +One caveat: this app uses the Web Serial API, which is only supported on Chromium-based browsers. |
| 18 | + |
| 19 | +## Getting Started (Developer) |
| 20 | + |
| 21 | +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. |
| 22 | + |
| 23 | +Due to the use of ECMAScript modules, a web server is required. Options include: |
| 24 | + |
| 25 | +1. Use the [Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) VSCode extension. |
| 26 | +2. From the `public` directory, invoke python's built-in module: `python3 -m http.server` |
| 27 | + |
| 28 | +By default, this puts up the site on `http://127.0.0.1:5500/` (Live Server) `http://127.0.0.1:8000` (http.server). |
| 29 | + |
| 30 | +## Contributing |
| 31 | + |
| 32 | +Please contribute your suggestions and/or your code! |
| 33 | + |
| 34 | +This project is still in early stages. Feel free to submit drafts as PRs; I will help finalize them. |
8 | 35 |
|
9 | 36 | ## Attributions |
10 | 37 |
|
11 | | -This repository includes the following third-party resources: |
| 38 | +This repository includes the following third-party assets: |
12 | 39 |
|
13 | 40 | - **Font: jiskan16** |
14 | 41 | - License: Public Domain |
|
0 commit comments