Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
raphamorim committed Sep 10, 2023
1 parent 759a1d2 commit 2d23897
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,11 +231,11 @@ async function loadRom(file) {

tl;dr: You can see the destop example in the example folder ([`/examples/desktop`](/examples/desktop))

1. Add `lr35902` as dependency and make sure to have `desktop` as feature on:
1. Add `gameboy` as dependency:

```toml
[dependencies]
gameboy = { version = "0.1.0", features = ["desktop"] }
gameboy = { version = "0.1.1" }
```

2. There you go:
Expand All @@ -246,14 +246,11 @@ gameboy = { version = "0.1.0", features = ["desktop"] }
use gameboy::gameboy::{Gameboy, RenderMode::Desktop};

fn main() {
let mut gb = Gameboy::new();
match gb.load_rom("./sample-rom.gb") {
Ok(..) => {
gb.render(Desktop);
}
Err(err) => {
println!("{:?}", err);
}
if let Ok((data, filepath)) = load_rom("./my-rom.gb") {
let gb = Gameboy::new(data, Some(filepath));
gb.render(Desktop);
} else {
panic!("error loading rom");
}
}
```
Expand All @@ -264,7 +261,7 @@ The tests are based on Blargg's Gameboy hardware test ROMs.

Link to the repository: https://github.com/retrio/gb-test-roms.git

| Tests (originally ran in [Openemu](https://openemu.org/)) | LR35902 Status
| Tests (originally ran in [Openemu](https://openemu.org/)) | Status
| --- | --- |
| ![CPU instructions test](resources/tests/cpu-instrs.png) ||
| ![Bits Unused test](resources/tests/bits-unused.png) | Failing |
Expand Down

0 comments on commit 2d23897

Please sign in to comment.