aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md18
1 files changed, 11 insertions, 7 deletions
diff --git a/README.md b/README.md
index ec08819..1a777e6 100644
--- a/README.md
+++ b/README.md
@@ -4,27 +4,31 @@ 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.
+# Example
+Check this [my website](https://ariamath.xyz).
+
# License
See LICENSE file for more information.
+# Contribute
+Send me your patches on [email](mailto:sabr@ariamath.xyz) or [xmpp](xmpp:sabr@ariamath.xyz).
+
+Though this tool is pretty much perfect already... I guess?
+
# Usage
You use your shell pipes '>' and '<'.
-* generate one html from gmi file
+- Generate one html from gmi file
```
./g2h < index.gmi > index.html
```
-
-* Generate a whole ass mfkin gemsite
+- Generate a whole ass mfkin gemsite
```
-./c2x <gemsite_root>
+./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.
-Btw [my website](https://ariamath.xyz) is a good example to look at. Read the Addenum.
-
# 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.