Add pyinstxtractor

README.md

@@ -1,2 +1,47 @@
-# pyinstxtractor
-PyInstaller Extractor
+# PyInstaller Extractor
+
+PyInstaller Extractor is a Python script to extract the contents of a PyInstaller generated Windows executable file. The contents of the pyz file (usually pyc files) present inside the executable are also extracted.
+
+The header of the pyc files are automatically fixed so that a Python bytecode decompiler will recognize it. The script can run on both Python 2.x and 3.x. Pyinstaller versions 2.0, 2.1, 3.0, 3.1, 3.2, 3.3, 3.6 are supported. Probably will work with other versions too.
+
+This project was originally hosted on [SourceForge](https://sourceforge.net/projects/pyinstallerextractor/).
+
+## How to use 
+
+The script can be run by passing the name of the exe as an argument.
+
+```
+$ python pyinstxtractor.py <filename>
+X:\>python pyinstxtractor.py <filename>
+```
+
+It is recommended to run the script in the same version of Python which was used to generate the executable. This is to prevent unmarshalling errors(if any) while extracting the PYZ archive.
+
+## Example
+
+```
+X:\> python pyinstxtractor.py test.exe
+[+] Processing dist\test.exe
+[+] Pyinstaller version: 2.1+
+[+] Python version: 36
+[+] Length of package: 5612452 bytes
+[+] Found 59 files in CArchive
+[+] Beginning extraction...please standby
+[+] Possible entry point: pyiboot01_bootstrap.pyc
+[+] Possible entry point: test.pyc
+[+] Found 133 files in PYZ archive
+[+] Successfully extracted pyinstaller archive: dist\test.exe
+
+You can now use a python decompiler on the pyc files within the extracted directory
+```
+
+After extracting the pyc's you can use a Python decompiler like [Uncompyle6](Ihttps://github.com/rocky/python-uncompyle6/).
+
+```
+X:\> uncompyle6.exe test.exe_extracted\test.pyc
+X:\> uncompyle6.exe test.exe_extracted\PYZ-00.pyz_extracted\__future__.pyc
+```
+
+## License
+
+GNU General Public License v3.0