Updated README.md.

seth1002 · Feb 1, 2019 · 9cd37ef · 9cd37ef
1 parent 3715c6e
commit 9cd37ef
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -13,6 +13,23 @@ This is an educational project to learn more about the ELF file format and [Unic
 - All JavaVM, JNIEnv and hooked functions are handled by python.
 - Enable VFP support.
 
+## Usage
+
+> In the future this will be possible through pypi.
+
+Make sure you are using python 3.
+
+1. Clone the repository
+2. Run `pip install -r requirements.txt`
+3. Run `python example.py`
+
+> If you have trouble getting the `keystone-engine` dependency on Windows (as I did):
+> 1. Clone their [repository](https://github.com/keystone-engine/keystone)
+> 2. Open a terminal in `bindings/python`
+> 3. Run `python setup.py install` (Make sure you are using python 3)
+> 4. Download their `Windows - Core engine` package [here](http://www.keystone-engine.org/download/) for your python arch.
+> 5. Put the `keystone.dll` in `C:\location_to_python\Lib\site-packages\keystone\`.
+
 ## TODO
 
 - Improve file descriptors in `vfs/file_system.py` so they are re-useable.

diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,4 @@
 unicorn==1.0.1
 pyelftools==0.24
-hexdump==3.3
+hexdump==3.3
+keystone-engine==0.9.1.post3