--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Sat Feb 15 23:21:29 2025 +0100
@@ -0,0 +1,27 @@
+c2html - Formats source code using HTML.
+
+Build Instructions:
+
+  1. Download and install UCX (https://ucx.sourceforge.io)
+  2. Run ./configure --release
+  3. Run make (produces c2html binary in build directory)
+  4. Or run make lib (produces include dir and static lib in dist directory)
+
+Usage of binary file:
+  c2html [Options] FILE
+
+ Options:
+  -h                    Prints help message
+  -j                    Highlight Java instead of C source code
+  -o <output>           Output file (stdout, if not specified)
+  -H <header>           Prepend header file
+  -F <footer>           Append footer file
+  -p                    Disable highlighting (plain text)
+  -l                    Disable line numbers
+  -V, -v                Prints version and exits
+
+Usage of static library:
+
+  1. Copy the contents of the dist directory to your project.
+  2. Include c2html.h and use one of the functions declared in this header
+  3. Link against the libc2html.a