Leahnaya/gba-link-connection
1
0
Fork 0
mirror of https://github.com/afska/gba-link-connection.git synced 2026-10-01 21:36:53 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improving Usage section in README

Browse Source
This commit is contained in:
Rodrigo Alfonso
2024-08-08 00:27:29 -03:00
parent 691b8fcddf
commit 703a41aa2d
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -24,12 +24,13 @@ A set of Game Boy Advance (GBA) C++ libraries to interact with the Serial Port.
## Usage
- Copy the `lib/` folder into your project's `include` directory and include the library you need, such as [LinkCable.hpp](lib/LinkCable.hpp). For initial instructions and setup details, refer to the big comment block at the beginning of each file, the documentation included here, and the provided examples. No external dependencies are required.
- Copy the contents of the `lib/` folder into a directory that is part of your project's include path. Then, `#include` the library you need, such as [LinkCable.hpp](lib/LinkCable.hpp), in your project. No external dependencies are required.
- For initial instructions and setup details, refer to the big comment block at the beginning of each file, the documentation included here, and the provided examples.
- Check out the [examples](examples) folder.
* The example code uses [libtonc](https://github.com/gbadev-org/libtonc) (and [libugba](https://github.com/AntonioND/libugba) for interrupts), but any library can be used.
* Builds are available in [Releases](https://github.com/afska/gba-link-connection/releases).
* They can be tested on real GBAs or using emulators.
* For `LinkCable`/`LinkWireless`/`LinkUniversal` there are stress tests that you can use to tweak your configuration.
* Compiled ROMs are available in [Releases](https://github.com/afska/gba-link-connection/releases).
* The examples can be tested on real GBAs or using emulators.
* For `LinkCable`/`LinkWireless`/`LinkUniversal`, there are stress tests that you can use to tweak your configuration.
To learn implementation details, you might also want to check out the [docs](docs) folder, which contains important documentation.