Skip to content

Commit e2e3744

Browse files
committed
docs: README improvements
1 parent fe793ae commit e2e3744

File tree

3 files changed

+31
-3
lines changed

3 files changed

+31
-3
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ Thumbs.db
77
*.swo
88
*.bak
99
*.tmp
10+
temp/

README.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,41 @@
11
# LED Matrix Vocab
22

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!
44

55
Live demo: https://jpadgett314.github.io/led-matrix-vocab
66

7-
This app uses the Web Serial API, which is only supported on Chromium-based browsers.
7+
![Animation of scrolling text on LED Matrix modules](/docs/demo.webp)
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.
835

936
## Attributions
1037

11-
This repository includes the following third-party resources:
38+
This repository includes the following third-party assets:
1239

1340
- **Font: jiskan16**
1441
- License: Public Domain

docs/demo.webp

841 KB
Loading

0 commit comments

Comments
 (0)