README: update introduction to pokemontools

The previous version of the README was leftover from when all of the
source code was just files inside of extras/ in the pokecrystal repo.
This commit is contained in:
Bryan Bishop 2013-11-11 20:40:28 -06:00
parent fd10868994
commit ab1a60ef46

View File

@ -1,3 +1,49 @@
pokemontools
==============================
``pokemontools`` is a python module that provides various reverse engineering
components for various Pokémon games. This includes:
* a utility to disassemble bytes from games into asm
* map editor
* python bindings for Pokémon games running in the vba-linux emulator
* in-game graphics converter (png, lz, 2bpp)
* preprocessor that dumps out rgbds-compatible asm
* stuff that parses and dumps data from ROMs
# installing
To install this python library in ``site-packages``:
```
pip install --upgrade pokemontools
```
And for local development work:
```
python setup.py develop
```
And of course local installation:
```
python setup.py install
```
# testing
Run the tests with:
```
nosetests-2.7
```
# see also
* [Pokémon Crystal source code](https://github.com/kanzure/pokecrystal)
* [Pokémon Red source code](https://github.com/iimarckus/pokered)
Pokémon Crystal utilities and extras
==============================