initial commit

1 files changed, 22 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1028a45
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# pointer_scanner_linux
+
+A C++20 program which finds static pointer chains to addresses in dynamic 
+regions of memory.
+
+## Dependencies
+
+[CMake](https://cmake.org) : Cmake is a cross platform, open source build system generator.
+
+## Building from Source
+
+```console
+    $ git clone https://salvestromartin.com:443/nJ3ahxac/pointer_scanner_linux.git
+```                                                                             
+
+Then compile from source via cmake after moving into the pointer_scanner_linux 
+directory.
+```console                                                                      
+    $ cd ./pointer_scanner_linux
+    $ cmake ./
+    $ make
+```