sergiotarxz/Rsaves
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Adding some docs to the library.

Browse Source
This commit is contained in:
sergiotarxz 2023-01-30 22:41:07 +01:00
parent 5ca3a85937
commit 6e4a74aa6c
1 changed files with 32 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -4,8 +4,36 @@
TODO: Documentation. TODO: Documentation.
The gba ROM is literally a backup of my own cartragide in spanish. The save attached is my own save and it is there so you can try the example easily.
I have no rights over the ROM and you should not download or use it if you do ## Installation
not have a copy of the same exact cartragide, it is there for debugging purposes
and it is absolutely not covered by the license of the program. ### Linux
You will need the build-essentials equivalent for your distribution and Perl 5.34.1 or higher.
```
cpan .
```
And restart the shell.
## Trying the examples
```
perl Build.PL
./Build installdeps
perl -Ilib examples/all_pokemon_shiny.pl
```
If you want to try them without installing or
```
perl examples/all_pokemon_shiny.pl
```
If you have already installed the library.
## Contributing
You are welcome to contribute whatever you thing it is missing.