summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBryan Bishop <kanzure@gmail.com>2012-05-14 10:42:43 -0500
committerBryan Bishop <kanzure@gmail.com>2012-05-14 10:42:43 -0500
commit6b8b380535343ec72cecfb9f7f25a7425cb92261 (patch)
treed8696e696092734026229ff99814a34c454ba18f /README.md
parentf50df4df672e5984ea15cc37da4f40e598c9fb2d (diff)
improve extras/README.md opening sentence
original-commit-id: 3afb9602ebce53fa14c7360a22fb8b6ae5e4f557
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 36c28bb..d0a2119 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
Pokémon Crystal utilities and extras
==============================
-`crystal.py` parses the ROM into classes and objects. It prmarily parses map headers, "second" map headers, map event headers, map script headers, map triggers, map "callbacks", map blockdata, xy triggers, warps, people-events, texts and scripts. The purpose of the file is to parse the ROM into python and then spit it back out with the global `to_asm()` method.
+`crystal.py` parses the ROM and provides convenient classes to dump human-readable ASM with the global `to_asm()` method. This ASM can then be compiled back into the original ROM. Currently it parses map headers, "second" map headers, map event headers, map script headers, map triggers, map "callbacks", map blockdata, xy triggers, warps, people-events, texts and scripts.
#### Simple ASM generation example