Merge pull request #4 from caffinatedmonkey/readme

Cleaned up README
pspdev · Jun 7, 2014 · 08849d8 · 08849d8
2 parents 9970651 + 04779e6
commit 08849d8
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 29 deletions.
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,37 @@
+PRXTool
+=======
+This is a simple tool to manipulate Sony PSP(tm) PRX files. Prxtool can:
+
+* output an IDC file which can be used with IDA Pro
+* output an ELF file
+* disassemble PRX files into a pretty printed format
+
+Installation
+------------
+
+To compile `prxtool`, run:
+
+ $ ./bootstrap
+ $ ./configure
+ $ make
+
+You can install it by running:
+
+ $ [sudo] make install
+
+License
+-------
+
+TyRaNiD (c) 2k6
+
+PRXTool is licensed under the AFL v2.0. Please read the LICENSE file for further
+information.
+
+Thanks to
+
+* Mrbrown for adding autoconfig
+* all the other people who contribute to legit PSP dev work.
+
+This is a good companion to libdoc as that provides the XML file used to get
+names and such for functions.
+