@@ -24,7 +24,7 @@ commands. It even has a few minigames!
24
24
You can check out this repository using git (or
25
25
[ download a zip file from GitHub] ( https://github.com/toaq/kuna/archive/refs/heads/main.zip ) )
26
26
and run the code on your computer using
27
- [ Node.js] ( https://nodejs.org/en/download/ ) .
27
+ [ Node.js] ( https://nodejs.org/en/download/ ) and [ pnpm ] ( https://pnpm.io/ ) .
28
28
29
29
For proper PNG rendering, install
30
30
[ Noto Sans Math] ( https://fonts.google.com/noto/specimen/Noto+Sans+Math ) .
@@ -33,26 +33,26 @@ To run as a web app (at <http://localhost:5173/>), run these commands in a
33
33
terminal:
34
34
35
35
``` sh
36
- npm install
37
- npm run web -- --port 5173
36
+ pnpm install
37
+ pnpm run web -- --port 5173
38
38
```
39
39
40
40
To run as a CLI app:
41
41
42
42
``` sh
43
- npm install
44
- npm run cli
43
+ pnpm install
44
+ pnpm run cli
45
45
# e.g.
46
- npm run cli -- tree-text --sentence " Jaı jí"
46
+ pnpm run cli -- tree-text --sentence " Jaı jí"
47
47
```
48
48
49
49
To run as a Discord bot:
50
50
51
51
``` sh
52
52
export KUNA_CLIENT_ID=your.discord.client.id
53
53
export KUNA_TOKEN=your.discord.bot.token
54
- npm install
55
- npm run bot
54
+ pnpm install
55
+ pnpm run bot
56
56
```
57
57
58
58
## How Kuna works
@@ -74,9 +74,9 @@ npm run bot
74
74
75
75
## Useful commands
76
76
77
- - ` npm run data:build` downloads all English definitions from Toadua and guesses
78
- glosses and frames, storing the result in ` data/toadua/toadua.json ` .
77
+ - ` pnpm run data:build` downloads all English definitions from Toadua and
78
+ guesses glosses and frames, storing the result in ` data/toadua/toadua.json ` .
79
79
- The result is checked into version control for convenience, but we can run
80
80
this every once in a while to teach Kuna new words.
81
- - ` npm run codegen` converts ` src/toaq.kuna.ne ` to ` src/toaq.ne ` . This runs
82
- automatically after ` npm install` .
81
+ - ` pnpm run codegen` converts ` src/toaq.kuna.ne ` to ` src/toaq.ne ` . This runs
82
+ automatically after ` pnpm install` .
0 commit comments