storytold/spark
2
0
Fork 0
mirror of https://github.com/storytold/spark.git synced 2026-10-17 00:12:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

update README to clarify asset download is optional

Browse Source
This commit is contained in:
Winnie Lin
2025-05-28 17:25:03 -07:00
committed by Diego Marcos
parent fa63689567
commit ed97485144
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -7
View File
@@ -105,12 +105,6 @@ npm install forge-dev
## Run Examples ## 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. Install [Rust](https://www.rust-lang.org/tools/install) if it's not already installed in your machine.
Next, build Forge by running: 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`). 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 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. 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 ## Develop and contribute to the project
Here are some additional development tips and instructions: Here are some additional development tips and instructions:
### Build troubleshooting ### Build troubleshooting