aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README30
1 files changed, 30 insertions, 0 deletions
diff --git a/README b/README
index a5945df..f6037f9 100644
--- a/README
+++ b/README
@@ -1 +1,31 @@
KPL
+
+---
+
+Requirements:
+
+Linux 6+
+GCC 14+
+make
+
+---
+
+Building:
+
+make
+
+---
+
+Running:
+
+./kpl [OPTIONS] ./path/to/file.kpl # Run File
+./kpl [OPTIONS] # Start REPL
+./kpl -h # See OPTIONS
+
+---
+
+Testing:
+
+See TESTING
+
+---