From 18fcfbb8604110e3b533781e7d94ace35d6d8ea8 Mon Sep 17 00:00:00 2001
From: Thomas Voss <mail@thomasvoss.com>
Date: Sat, 9 Sep 2023 11:07:29 +0200
Subject: Add a README

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

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fad71d3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,53 @@
+`GSP` (pronounced _gee ess pee_) is a transpiler to convert a nicer to write and
+more human-friendly syntax into valid HTML.  Writing HTML can be made more
+bearable using things like Emmet, but it’s still not great, and the syntax is
+far too bloated, visually polluting your documents.
+
+`GSP` will never support templating or other useless features.  If you need
+support for such things, just use a programming- or macro language such as
+Python or M4.
+
+## Why Not Use Pug or [INSERT LANGUAGE HERE]
+
+Simply put, they are all trash.  Pug has decent syntax but requires you use
+JavaScript.  All the others fall for the same kind of problem.  As far as I
+could find, there is no pre-GSP transpiler from good syntax to HTML that works
+as just one binary you call on some files.  All options force you into needing
+to write JavaScript/Ruby/etc. scripts, which just isn’t good enough.
+
+## Syntax Example
+
+```gsp
+html lang="en" {
+  head {
+    meta charset="UTF-8"
+    meta name="viewport" content="width=device-width, initial-scale=1.0"
+    link href="/favicon.svg" rel="shortcut icon" type="image/svg"
+    link href="/style.svg" rel="stylesheet"
+    title {-My Website Title}
+  }
+  body {
+    p #my-id  {- This is a paragraph with the id ‘my-id’     }
+    p .my-cls {- This is a paragraph with the class ‘my-cls’ }
+
+    p
+      #some-id
+      .class-1
+      .class-2
+      key-1="value-1"
+      key-2 = "value-2"
+    {-
+      This paragraph has an ID, two classes, and two additional attributes.  GSP
+      allows us to use the ‘#ident’ and ‘.ident’ syntaxes as shorthands for
+      applying IDs, and classes.  This is a text node, so nothing is being
+      interpreted as GSP nodes, but we can include them inline if we want.  As
+      an example, here is some @em {-emphatic} text.  Your inline nodes can also
+      have attributes @em #id .cls {-just like a regular node}.
+    }
+  }
+}
+```
+
+## Why The Name GSP?
+
+I was originally inspired by Pug, but my dog is a GSP, not a pug.
-- 
cgit v1.2.3