aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a5a8e38
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# xop
+
+## xop -- Please don't use this program unless you're manually decoding machine code.
+
+Compile: `$ sh compile.sh`
+
+Install: `$ sudo sh install.sh`
+
+License: GNU/GPLv3
+
+This library depends on (these libraries are included in static version of the program):
+- xtandard: https://gitlab.com/xolatile/xtandard
+
+About this program:
+- It is extremely slow, it's written to be generic and extensible, not language specific or optimized.
+- Everything related to my libraries is clean of all warning options on GCC and Valgrind (hopefully).
+
+Use:
+```bash
+# xop this_or_that.bin
+```