Merge pull request #17 from kanzure/readme-redtools

Basic README for redtools/

1 files changed, 40 insertions, 0 deletions

diff --git a/redtools/README.md b/redtools/README.md
new file mode 100644
index 0000000..ec2a4e7
--- /dev/null
+++ b/redtools/README.md
@@ -0,0 +1,40 @@
+# redtools
+
+The `redtools` are mostly python files that were removed from the
+[pokered](https://github.com/iimarckus/pokered) project.
+
+# Why was this removed from pokered?
+
+Originally, `extras/` was where all tools where put in the pokered project.
+These utilities and tools were for disassembling the ROM, extracting data, and
+prettifying text. When the
+[pokecrystal](https://github.com/kanzure/pokecrystal) project started, many of
+these tools were copied into pokecrystal. This was a mistake because it meant
+that there were two copies of the same python source code in two places. This
+causes all sorts of problems because if a bug is found in one repository, it's
+really hard to figure out if the bug applies to the other project, or to keep
+track of where the bugs have been fixed or not fixed. The effects are
+duplication of effort, less progress overall, and so on.
+
+# Moving forward
+
+These files should be merged into the `pokemontools/` module. More tests need
+to be written to make sure some of the functionality has been preserved.
+
+# What about just deleting everything?
+
+Everything in here could be deleted without negatively impacting pokered
+builds. But there will be some lost effort, like the pretty text inserter.
+
+# Things worth keeping or redoing
+
+* pretty text - this is a command line tool that parses text from the ROM at a
+  given address, and dumps out pretty-formatted asm ready for insertion.
+
+* gbz80disasm - might have one or two fixes ahead of
+  pokemontools/gbz80disasm.py, but is significantly inferior in general.
+
+* romviz and romvisualizer - makes an animated gif of progress removing
+  INCBINs. Needs to be rewritten to follow INCLUDEs.
+
+* maybe other things