Skip to content

Commit bcdeba0

Browse files
committed
Migrate to pnpm
1 parent 77d15b5 commit bcdeba0

File tree

5 files changed

+287
-4064
lines changed

5 files changed

+287
-4064
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ commands. It even has a few minigames!
2424
You can check out this repository using git (or
2525
[download a zip file from GitHub](https://github.com/toaq/kuna/archive/refs/heads/main.zip))
2626
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/).
2828

2929
For proper PNG rendering, install
3030
[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
3333
terminal:
3434

3535
```sh
36-
npm install
37-
npm run web -- --port 5173
36+
pnpm install
37+
pnpm run web -- --port 5173
3838
```
3939

4040
To run as a CLI app:
4141

4242
```sh
43-
npm install
44-
npm run cli
43+
pnpm install
44+
pnpm run cli
4545
# e.g.
46-
npm run cli -- tree-text --sentence "Jaı jí"
46+
pnpm run cli -- tree-text --sentence "Jaı jí"
4747
```
4848

4949
To run as a Discord bot:
5050

5151
```sh
5252
export KUNA_CLIENT_ID=your.discord.client.id
5353
export KUNA_TOKEN=your.discord.bot.token
54-
npm install
55-
npm run bot
54+
pnpm install
55+
pnpm run bot
5656
```
5757

5858
## How Kuna works
@@ -74,9 +74,9 @@ npm run bot
7474

7575
## Useful commands
7676

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`.
7979
- The result is checked into version control for convenience, but we can run
8080
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

Comments
 (0)