First commit

1 files changed, 29 insertions, 0 deletions

diff --git a/ReadMe.md b/ReadMe.md
new file mode 100644
index 0000000..3e8dab2
--- /dev/null
+++ b/ReadMe.md
@@ -0,0 +1,29 @@
+# ida_game_elf_loaders
+A collection of user mode ELF loaders for the following game consoles:
+* PS3
+* PS Vita
+
+## Installation
+Copy loader plugins to IDA loaders directory.
+
+## Building
+
+### Dependencies
+* IDA SDK
+* [CMake](https://cmake.org/download/)
+
+### Generate Projects With CMake
+The IDA cmake module included will expect to find the IDA SDK in an `IDA_SDK_DIR` or `IDA_SDK` environment variable.
+If you would like to generate 64-bit EA targeted loaders, you need to add `-DIDA_64_BIT_EA_T=YES` to cmake command line.
+
+Navigate to the directory of the loader you would like to build in 'src/', then run the following command
+`mkdir build && cd build && cmake ../`
+
+This should create a build directory with your generated project files.
+
+### Building
+Optionally, you can also build using cmake with the following command
+`cmake --build ./`
+
+## Notes
+These have only been tested and built using Visual Studio 2015 using IDA SDK 6.8.
\ No newline at end of file