aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..660df47
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# Lillero-mapping-writer
+Simple CLI program for converting and reversing mappings. Because apparently Enigma can't.
+
+## Usage
+Follow the format:
+```
+java -jar mapping-writer.jar [-r] <location> <format> <output>
+```
+
+where `<location>` is where to find the mapping to convert, `<format>` is a supported format, `<output>` is the name of the output file, and `-r` makes it so that the mapping is inverted. \ No newline at end of file