From bef45dc6bde2d973e4410d932b492c09bcf9e15b Mon Sep 17 00:00:00 2001
From: axtloss <axtlos@getcryst.al>
Date: Tue, 9 Jul 2024 22:48:07 +0200
Subject: Add readme and license

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

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)
-- 
cgit v1.2.3