Skip to content

Commit

Permalink
docs: add local development instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
avivace committed Sep 19, 2023
1 parent 9425d7e commit f3a7712
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# rgbds-live

A live Gameboy programming environment in the browser,allowing for realtime assembly programming for the gameboy. Powered by webassembly builds of RGBDS and the Binjgb emulator.
A live Gameboy programming environment in the browser, allowing for realtime assembly programming for the gameboy. Powered by webassembly builds of [RGBDS](https://rgbds.gbdev.io/) and the [Binjgb](https://github.com/binji/binjgb) emulator.

Try online at [gbdev.io/rgbds-live](https://gbdev.io/rgbds-live/).

## Build

Expand All @@ -9,3 +11,13 @@ System requirements:
- bison, cmake
- [emscripten](https://emscripten.org/docs/getting_started/downloads.html)

To build RGBDS live and run it locally:

```bash
# Pull RGBDS-live, rgbds and binjgb sources
https://github.com/gbdev/rgbds-live
# Generate WASM builds and put them in the main source folder
./build.sh
```

Final build will be in `www/`. You can run the provided `serve-site.sh` to serve that folder locally over port 8080.

0 comments on commit f3a7712

Please sign in to comment.