diff --git a/README.md b/README.md index 36d94ac..0a912f8 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,46 @@ **build tool for the gxi-rs project** -## Install +## Web + +`gxib web` helps compile the project to ready to use `.wasm` files. + +Inbuilt web server with hot reload for faster development. ```bash -cargo install gxib +gxib web -wrs localhost:8080 ``` -## Usage +### Docker -Run in project root dir. +contains all dependencies required for web builds -## Web +_mounts current dir to /app and exports port 8080_ + +```bash +docker run \ + -p 8080:8080 \ + -v $(pwd):/app \ + -it ghcr.io/gxi-rs/gxib:latest +``` + +### Run + +```bash +cd /app +gxib web +``` + +### Dependencies + +if you don't want to use the prebuilt docker image, the following dependencies need +to be present in your dev environment. -### Requirements +- install `gxib` + + ```bash + cargo install gxib + ``` - install `wasm32-unknown-unknown` architecture @@ -31,12 +58,6 @@ Run in project root dir. - [Binaryen](https://www.google.com/search?q=install+binaryen) for reducing wasm bundle size with `wasm-opt -Oz` -## Run - -```bash -gxib web -``` - ## Roadmap - [x] Basic desktop gtk builds