aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3bb3e00
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# xuxuxu
+
+## xuxuxu -- Program for rendering C source code files to PNG image format in TempleOS style.
+
+Compile: `$ sh compile.sh`
+
+Install: `$ sudo sh install.sh`
+
+License: GNU/GPLv3
+
+This library depends on (these libraries are included in static version of the program):
+- xtandard: https://gitlab.com/xolatile/xtandard
+- xyntax: https://gitlab.com/xolatile/xyntax
+- xormat: https://gitlab.com/xolatile/xormat
+
+About this program:
+- It is extremely slow, it's written to be generic and extensible, not language specific or optimized.
+- You can easily add new syntax support with it, for your own language or some that I didn't include.
+- Everything related to my libraries is clean of all warning options on GCC and Valgrind (hopefully).
+
+Use:
+```bash
+$ xuxuxu < my_program.c"
+```
+
+![screenshot](screenshot.png)