Add files

1 files changed, 25 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b5838a1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# Gemini To XHTML(XML)
+This is a very simple gemini to xml generator written in C.
+
+# About
+The g2x executable is a single file to file xml generator, there's a handy script named c2x (capsule 2 xhtml), that generates the entire capsule in XHTML for you, then you can use your favourite web server to host it.
+
+# Usage
+You use your shell pipes '>' and '<'.
+
+* generate one html from gmi file
+```
+./g2h < index.gmi > index.html
+```
+
+* Generate a whole ass mfkin gemsite
+```
+./c2x <gemsite_root>
+```
+
+without the "/"... btw.
+
+That's it, just add your style.css at the *_xhtml root and you got XHTML! HELL YEAH! Hhhmm... I mean HTML is kinda messed up and you should always just use XHTML.
+
+# Addenum
+I thought I might add how I work. I have my gemsite as a git repo where I have a post-receive hook that copies my gemsite to a gemsite folder, and then it runs `c2x` on the gemsite root folder and I get a `gemsite_xhtml` folder, being the XHTML root. Then I just nginx and you know the deal.