Skip to content

Commit 723677d

Browse files
committed
chore: modify readme
1 parent 58de39f commit 723677d

File tree

4 files changed

+26
-2
lines changed

4 files changed

+26
-2
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
/target
22
**/node_modules
3+
**/build

www/README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
1-
# open-chess-clock-frontend
1+
# OpenChessClock Web
22

3-
A browser display for `open-chess-clock`.
3+
A browser display for `open-chess-clock`. A vanilla JS web app built with Vite.
4+
5+
A little bit hacky, but it works! The website can connect to a chess clock
6+
flashed with [this firmware](../README.md)!
7+
8+
## Screenshots
9+
10+
![selection screen](./assets/selection.png)
11+
![synced with a physical clock](./assets/sync.png)
12+
13+
## Translations
14+
15+
I'd love to translate this, but this was a quick-and-dirty (though not as dirty
16+
as some other projects) web app and isn't set up for that. PRs welcome!
17+
18+
## Dev server
19+
20+
Run `pnpm dev` to start up the dev server on `localhost:5173`. The port may
21+
differ if port 5173 isn't available. You should see a message from Vite telling
22+
you the port number.
23+
24+
## Build instructions
25+
26+
Run `pnpm build` to type-check and run the build script.

www/assets/selection.png

105 KB
Loading

www/assets/sync.png

69 KB
Loading

0 commit comments

Comments
 (0)