Skip to content

Commit c9efa2e

Browse files
committed
docs: add pnpm seed to README and clarify userData path in AGENTS
1 parent d0522d6 commit c9efa2e

2 files changed

Lines changed: 3 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
**Freesound API key:** Set inside the app's Settings UI (not a `.env` file). Stored at `$USERDATA/settings.json` (`app.getPath('userData')`). Only needed to use Freesound search inside the app — not required for seeding.
44

5-
**Seed script:** Run `pnpm dev` at least once first (creates the SQLite database), then `pnpm seed`. Audio files are bundled in `scripts/seed-audio/` — no API key or network access needed.
5+
**Seed script:** Run `pnpm dev` at least once first (creates the SQLite database), then `pnpm seed`. Audio files are bundled in `scripts/seed-audio/` — no API key or network access needed. userData is always at `~/Library/Application Support/samplebyte/` in both dev and production builds (prior to the `app.setName()` fix, dev mode used `~/Library/Application Support/Electron/` instead).

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,8 @@ pnpm dev # development (hot reload)
121121
pnpm build # production build
122122
```
123123

124+
Run `pnpm seed` after the first `pnpm dev` to populate the database with demo projects and chops (no API key or network needed).
125+
124126
Requires Node.js v18+ and pnpm. The project pins its pnpm version in `package.json`.
125127

126128
---

0 commit comments

Comments
 (0)