Skip to content

Commit

Permalink
Documentation Update (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] authored Jun 6, 2024
1 parent d5551fb commit b498b91
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![Quality](https://github.com/dbut2/sapphire/actions/workflows/quality.yaml/badge.svg)](https://github.com/dbut2/sapphire/actions/workflows/quality.yaml)
[![Build](https://github.com/dbut2/sapphire/actions/workflows/build.yaml/badge.svg)](https://github.com/dbut2/sapphire/actions/workflows/build.yaml)

Sapphire is an Emulator for the Game Boy Advance (GBA) system written in Go.
Sapphire is an emulator for the Game Boy Advance (GBA) system written in Go.

## Installation

Expand Down Expand Up @@ -31,18 +31,20 @@ Ensure the ROM file is a `.gba` file that represents a Game Boy Advance game.

## Development

Sapphire is a big work in progress, and contributions are welcome. Visit the project's issues page to report any bugs or feature requests and to see the list of known issues.
Sapphire is a work in progress, and contributions are welcome. Visit the project's issues page to report any bugs or feature requests and to see the list of known issues.

For development, besides the standard Go tools, Sapphire includes a `Makefile` that simplifies common tasks:

- `make clean` - Remove any build artifacts.
- `make build` - Build the project for the macOS platform.
- `make run` - Build and execute the project for the macOS platform.
- `make build` - Build the project for macOS.
- `make run` - Build and execute the project for macOS.
- `make run-debug` - Execute the debugger for the project.
- `make package` - Package the built binary for distribution.
- `make test` - Run tests.
- `make lint` - Run linter to check the code.

## License

Sapphire is licensed under the [MIT License](https://opensource.org/licenses/MIT).
Sapphire is licensed under the [MIT License](https://opensource.org/licenses/MIT).

![Sapphire](sapphire.png)

0 comments on commit b498b91

Please sign in to comment.