Skip to content

Commit

Permalink
Add instructions on how to add a ROM file
Browse files Browse the repository at this point in the history
  • Loading branch information
Anton Rissanen committed Jan 27, 2019
1 parent d664e71 commit 7dc22de
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
Expand Up @@ -6,7 +6,7 @@ A React-based web UI for [JSNES](https://github.com/bfirsh/jsnes).

$ yarn install
$ yarn start

## Building for production

$ yarn build
Expand All @@ -24,3 +24,15 @@ All code must conform to [Prettier](https://prettier.io/) formatting. The test s
To automatically format all your code, run:

$ yarn run format

## Adding roms

Open `src/config.js` and add a new key under the defined `config.ROMS`. For example:

myrom: {
name: "My Rom",
description: <span>This is my own homebrew NES rom</span>,
url: "http://localhost:3000/roms/myrom/myrom.nes"
}

If you add your rom file now under `public/roms/myrom/myrom.nes`, the game should start playing as you navigate to http://localhost:3000/myrom

0 comments on commit 7dc22de

Please sign in to comment.