docs: add setup document (#19)

tc39 · Feb 14, 2024 · 5bfeb1e · 5bfeb1e
1 parent 2f81f5a
commit 5bfeb1e
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -8,6 +8,28 @@ This project provide TC39 proposal latest status
   <br><https://tc39.es/dataset/proposals.json>
   <br><https://tc39.es/dataset/proposals.min.json> (Production)
 
+## Development
+
+Setup:
+
+```sh
+git clone https://github.com/tc39/dataset
+cd dataset
+# Install dependencies
+npm ci
+# Clone tc39/proposals and tc39/notes for make dataset
+git clone https://github.com/tc39/notes
+git clone https://github.com/tc39/proposal
+```
+
+Update dist files:
+
+```sh
+npm run build
+GITHUB_TOKEN=xxx npm run make-dataset # Pass GITHUB_TOKEN for avoid rate limit
+npm run make-scheme
+```
+
 ## LICENSE
 
 [UNLICENSE](LICENSE)