From ed97485144ca96990cb7e53d1d2db4ca65d383ba Mon Sep 17 00:00:00 2001 From: Winnie Lin Date: Wed, 28 May 2025 17:25:03 -0700 Subject: [PATCH] update README to clarify asset download is optional --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3d1a434..dc42799 100644 --- a/README.md +++ b/README.md @@ -105,12 +105,6 @@ npm install forge-dev ## Run Examples -Download the example assets files with the following command: - -``` -npm run assets:download -``` - Install [Rust](https://www.rust-lang.org/tools/install) if it's not already installed in your machine. Next, build Forge by running: @@ -120,12 +114,18 @@ npm run build ``` This will first build the Rust Wasm component (can be invoked via `npm run build:wasm`), then Forge itself (`npm run build`). -Once you've fetched the data and built Forge, you can now run the examples: +The examples fetch assets from a remote URL. This step is optional, but offline development and faster loading times are possible if you download and cache the assets files locally with the following command: +``` +npm run assets:download +``` + +Once you've built Forge and optionally downloaded the assets, you can now run the examples: ``` npm start ``` This will run a dev server by default at [http://localhost:8080/](http://localhost:8080/). Check the console log output to see if yours is served on a different port. + ## Develop and contribute to the project Here are some additional development tips and instructions: ### Build troubleshooting