aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..631c61c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# runc
+Execute source files based on a static configuration
+
+## Building
+```sh
+./configure
+make
+```
+
+## Usage
+`runc /path/to/code`
+
+Example configurations are located in the `config` folder, runc reads two config directories, `/etc/runc.d` and `~/.config/runc`.
+
+The configuration has three valid fields:
+- `compiler`, the compiler command (required)
+- `args`, compiler arguments (optional)
+- `fileext`, the source file extension (required)