From ab1a60ef461a3ca3ecb621f858fde59a9a9fbc64 Mon Sep 17 00:00:00 2001
From: Bryan Bishop <kanzure@gmail.com>
Date: Mon, 11 Nov 2013 20:40:28 -0600
Subject: 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.
---
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)

diff --git a/README.md b/README.md
index 760731b..9c3ca92 100644
--- a/README.md
+++ b/README.md
@@ -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
 ==============================
 
-- 
cgit v1.2.3