Skip to content

Commit

Permalink
Improved README
Browse files Browse the repository at this point in the history
  • Loading branch information
BriceCroix committed Jan 7, 2024
1 parent 9ac9067 commit 8823091
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,25 @@
# Chirp8

Chip-8 emulator written in Rust.
Chip-8 emulator library written in Rust.

The library is compatible with `no_std` environments and can be used to create handheld consoles on microcontrollers !

## Examples

- `minimal.rs` : Provides the bare minimum to use this library. Very suitable for embedded projects.
- `with_piston.rs` : An example of desktop application using the `piston` library to run your favorite chip-8 games on your computer.

## Crate features

| **Feature name** | **Description** | **Default-enabled** |
| :--------------: | :---------------------------------------------------------------------------------------------------: | :-----------------: |
| `alloc` | Allocates the objects that use the most memory on the heap (`Vec<T>`) instead of the stack (`[T; N]`) | yes |

## Testing

This library uses Timendus' chip8-test-suite as a git submodule.
This library uses [Timendus' tests suite](https://github.com/Timendus/chip8-test-suite.git) as a git submodule.
This is only needed if you wish to contribute to this library.
Please run the following to fetch this submodule :
Please run the following to pull the submodules :

```sh
git submodule update --init --recursive
Expand Down

0 comments on commit 8823091

Please sign in to comment.