mirror of
https://github.com/mattrberry/crab.git
synced 2025-01-05 11:01:33 +01:00
23 lines
956 B
Markdown
23 lines
956 B
Markdown
# crab
|
|
|
|
A very rough start to a Game Boy Advance emulator in Crystal Lang. The long-term goal is simply playability of popular titles. The name of the project come from the emudev discord, where "crab" was suggested for "Crystal Advanced Boy." Close enough.
|
|
|
|
## Installation
|
|
|
|
At the moment, a `shards install` is all that's required.
|
|
|
|
## Usage
|
|
|
|
This is not in a functional state. As arm instructions are being implemented, you can print the trace by compiling with `-Dtrace` or print logs by compiling with `-Dlog`. Next, simply provide the executable with the path to your rom.
|
|
|
|
## Contributing
|
|
|
|
1. Fork it (<https://github.com/mattrberry/crab/fork>)
|
|
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
3. Commit your changes (`git commit -am 'Add some feature'`)
|
|
4. Push to the branch (`git push origin my-new-feature`)
|
|
5. Create a new Pull Request
|
|
|
|
## Contributors
|
|
|
|
- [Matthew Berry](https://github.com/mattrberry) - creator and maintainer
|