crab/README.md

# 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
initial commit: load cartridge, parse instr types 2020-08-22 09:15:30 +02:00			`# crab`

initial minimum readme information 2020-09-18 08:55:34 +02:00			`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.`
initial commit: load cartridge, parse instr types 2020-08-22 09:15:30 +02:00
			`## Installation`

initial minimum readme information 2020-09-18 08:55:34 +02:00			At the moment, a `shards install` is all that's required.
initial commit: load cartridge, parse instr types 2020-08-22 09:15:30 +02:00
			`## Usage`

initial minimum readme information 2020-09-18 08:55:34 +02:00			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.
initial commit: load cartridge, parse instr types 2020-08-22 09:15:30 +02:00
			`## Contributing`

initial minimum readme information 2020-09-18 08:55:34 +02:00			`1. Fork it (<https://github.com/mattrberry/crab/fork>)`
initial commit: load cartridge, parse instr types 2020-08-22 09:15:30 +02:00			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`

initial minimum readme information 2020-09-18 08:55:34 +02:00			`- [Matthew Berry](https://github.com/mattrberry) - creator and maintainer`