aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoraxtloss <axtlos@getcryst.al>2024-07-09 22:48:07 +0200
committeraxtloss <axtlos@getcryst.al>2024-07-09 22:48:07 +0200
commitbef45dc6bde2d973e4410d932b492c09bcf9e15b (patch)
tree7e5102329d3639046cf964b17286f4c168167b75 /README.md
parentd050d9d43dc3a147c999b929ffa2fd198b71ff89 (diff)
downloadrunc-bef45dc6bde2d973e4410d932b492c09bcf9e15b.tar.gz
runc-bef45dc6bde2d973e4410d932b492c09bcf9e15b.tar.bz2
Add readme and license
Diffstat (limited to '')
-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)