diff options
| author | yenatch <yenatch@gmail.com> | 2013-04-05 00:25:47 -0400 |
|---|---|---|
| committer | yenatch <yenatch@gmail.com> | 2013-04-05 00:25:47 -0400 |
| commit | 51018f0b68b8906e41a0313338bb0cda537f1c78 (patch) | |
| tree | 1e0e843457a0ca34df35e60e3fa64b5307516e71 | |
| parent | f076f14b9806a517297efe649c4ae9cf4ae2025a (diff) | |
More readme formatting
| -rw-r--r-- | INSTALL.md | 19 | ||||
| -rw-r--r-- | README.md | 6 |
2 files changed, 18 insertions, 7 deletions
diff --git a/INSTALL.md b/INSTALL.md index f9e0578c6..7060b5e20 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -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 @@ -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)! -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 sudo apt-get install make gcc bison git python python-setuptools @@ -39,12 +41,18 @@ cd pokecrystal # install python requirements pip install -r requirements.txt +``` +To compile the ROM from ASM source: +``` 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. @@ -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`. 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! +`FC: no differences encountered`, the build was successful! Rejoice! Now you may try messing around with `main.asm`, or just do whatever you wanted to. @@ -24,6 +24,10 @@ Eventually this will not be necessary. ## 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)! |