Rooba
/
pokecrystal
mirror of https://github.com/pret/pokecrystal.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

More readme formatting

This commit is contained in:
yenatch 2013-04-05 00:25:47 -04:00
parent f076f14b98
commit 51018f0b68
2 changed files with 18 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
INSTALL.md
View File

@ -1,4 +1,6 @@
Installation requires a certain Pokemon Crystal ROM: # Getting Started
Compiling requires a certain Pokemon Crystal ROM:
``` ```
Pokemon - Crystal Version (UE) (V1.0) [C][!].gbc Pokemon - Crystal Version (UE) (V1.0) [C][!].gbc
@ -10,10 +12,10 @@ Save it as `baserom.gbc` in the repository.
Feel free to ask us on nucleus.kafuka.org #skeetendo if something goes wrong (remember to tell where)! Feel free to ask us on nucleus.kafuka.org #skeetendo if something goes wrong (remember to tell where)!
Don't know how to use IRC? Try [mibbit](http://chat.mibbit.com/?server=nucleus.kafuka.org&channel=#skeetendo) or something. Don't know how to use IRC? Try [mibbit](http://chat.mibbit.com/?server=nucleus.kafuka.org&channel=#skeetendo).
# Linux ## Linux
```bash ```bash
sudo apt-get install make gcc bison git python python-setuptools sudo apt-get install make gcc bison git python python-setuptools
@ -39,12 +41,18 @@ cd pokecrystal
# install python requirements # install python requirements
pip install -r requirements.txt pip install -r requirements.txt
```
To compile the ROM from ASM source:
```
make clean && make make clean && make
``` ```
That will take between 3 and 15 seconds, depending on your computer. If you see
`cmp baserom.gbc pokecrystal.gbc` as the last line, the build was successful! Rejoice!
# Windows
## Windows
Set up [GitHub for Windows](http://windows.github.com/) and clone this repository. Set up [GitHub for Windows](http://windows.github.com/) and clone this repository.
@ -61,8 +69,7 @@ Install [make](http://gnuwin32.sourceforge.net/downlinks/make.php) for Windows.
To compile the ROM from ASM source, run `pokecrystal.bat`. To compile the ROM from ASM source, run `pokecrystal.bat`.
That will take between 3 and 15 seconds, depending on your computer. If you see That will take between 3 and 15 seconds, depending on your computer. If you see
`cmp baserom.gbc pokecrystal.gbc` `FC: no differences encountered`, the build was successful! Rejoice!
as the last line, the build was successful! Rejoice!
Now you may try messing around with `main.asm`, or just do whatever you wanted to. Now you may try messing around with `main.asm`, or just do whatever you wanted to.

6
README.md
View File

@ -24,6 +24,10 @@ Eventually this will not be necessary.
## Contributing ## Contributing
* Hang out with us on IRC, nucleus.kafuka.org #skeetendo ([or use mibbit](http://chat.mibbit.com/?server=nucleus.kafuka.org&channel=#skeetendo)) * Hang out with us on IRC:
`nucleus.kafuka.org #skeetendo`
(or use [mibbit](http://chat.mibbit.com/?server=nucleus.kafuka.org&channel=#skeetendo)).
* Are we missing something? Make a pull request! Contributions are welcome.
* Tackle some [issues](https://github.com/kanzure/pokecrystal/issues)! * Tackle some [issues](https://github.com/kanzure/pokecrystal/issues)!