Update docs

gbdev · Jan 6, 2022 · 82e0fd2 · 82e0fd2
1 parent 54755f6
commit 82e0fd2
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 9 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,5 @@ dist/
 node_modules/
 *.swp
 **/.DS_Store
+.cache/
+.temp/
diff --git a/README.md b/README.md
@@ -1,12 +1,14 @@
-# gbdev landing page
+# gbdev website
 
-Source repository of the gbdev landing website. GitHub Pages serves the content of the `master` branch on [gbdev.github.io](https://gbdev.github.io). 
+Game Boy development website hosted at [gbdev.io](https://gbdev.io), powered by Vuepress 2.x
 
-> Development is done on the `dev` branch due to GitHub's restriction on branches for user pages.
+```bash
+# Install dependencies
+npm install
 
-Build and deploy:
-```
-npx vuepress build list/
-cp list/.vuepress/dist/* dist/list -R
-npx gh-pages -d dist -b master
-```
+# Start a local hot-reloading development server at http://localhost:8080
+npm run dev
+
+# Build website
+npm run build
+```
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,3 +2,5 @@ dist/ @@
     node_modules/
     *.swp
     **/.DS_Store
+    .cache/
+    .temp/