From 1ba470d34f4b5d610fb8458bdf854e8759b09d90 Mon Sep 17 00:00:00 2001 From: Lou Huang Date: Tue, 3 Dec 2024 01:03:01 -0500 Subject: [PATCH] docs(README): clarify installation instructions, resolve #107 --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 229d0988..2e805c99 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,26 @@ ## Development +### Quick start + ``` -$ yarn start +$ yarn install // installs all dependencies +$ yarn start // starts local server ``` -or +When started successfully, you may access the local server at http://localhost:8000/ + +### Troubleshooting + +Some issues can be resolved by clearing the cache and rebuilding files. The first command is less destructive, while the second resets your local environment from scratch. ``` $ yarn clear // clears local cache, builds (excludes node_modules) +``` + +or + +``` $ yarn clean // clears local cache, builds, node_modules, yarn trash ```