6 files changed, 264 insertions, 0 deletions
diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000..dab823a
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,11 @@
+all: ar-lulua.xmodmap ar-lulua.svg
+
+#letterfreq.json: ../stats.pickle
+#	lulua-plot -l ar-lulua letterfreq < $< > $@
+
+ar-lulua.xmodmap:
+	lulua-render xmodmap -l ar-lulua $@
+
+ar-lulua.svg:
+	lulua-render svg -l ar-lulua $@
+
diff --git a/doc/fonts/IBMPlexArabic-Regular.woff2 b/doc/fonts/IBMPlexArabic-Regular.woff2
new file mode 100644
index 0000000..bc5e155
--- /dev/null
+++ b/doc/fonts/IBMPlexArabic-Regular.woff2
diff --git a/doc/fonts/IBMPlexArabic-Thin.woff2 b/doc/fonts/IBMPlexArabic-Thin.woff2
new file mode 100644
index 0000000..685bd03
--- /dev/null
+++ b/doc/fonts/IBMPlexArabic-Thin.woff2
diff --git a/doc/index.html b/doc/index.html
new file mode 100644
index 0000000..815b2a4
--- /dev/null
+++ b/doc/index.html
@@ -0,0 +1,87 @@
+<!doctype html>
+<html lang="ar">
+<head>
+  <meta charset="utf-8">
+  <title>لؤلؤة</title>
+  <!--<meta name="description" content="">-->
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+
+	<link href="https://fonts.googleapis.com/css?family=IBM+Plex+Mono|IBM+Plex+Sans:100,400&display=swap" rel="stylesheet">
+	<link rel="stylesheet" href="https://unpkg.com/purecss@1.0.1/build/base-min.css" crossorigin="anonymous">
+	<link rel="stylesheet" href="https://unpkg.com/purecss@1.0.1/build/grids-min.css" crossorigin="anonymous">
+	<link rel="stylesheet" href="https://unpkg.com/purecss@1.0.1/build/grids-responsive-min.css" crossorigin="anonymous">
+	<script src="http://cdn.pydata.org/bokeh/release/bokeh-1.3.4.min.js"></script>
+	<link rel="stylesheet" href="style.css">
+</head>
+<body>
+
+<div class="title-card pure-g">
+	<div class="lbox">
+	<div class="pure-u-1 pure-u-lg-1-3">
+		<h1 lang="ar"><img class="logo" src="lulua-logo.svg"></h1>
+		<div class="pure-g flexreverse">
+			<div class="pure-u-1 pure-u-sm-1-2">
+				<!--<h2 class="subtitle">لوحة مفاتيح العربية المريحة</h1>-->
+			</div>
+			<div class="pure-u-1 pure-u-sm-1-2">
+				<h2 class="subtitle" lang="en">Ergonomic Arabic Keyboard Layout</h1>
+			</div>
+		</div>
+	</div>
+	<div class="pure-u-1 pure-u-lg-2-3" lang="en">
+		<div class="layout">
+			<img src="ar-lulua.svg" alt="لؤلؤة">
+		</div>
+	</div>
+	</div>
+</div>
+
+<div class="pure-g flexreverse">
+	<div class="pure-u-1 pure-u-md-1-2">
+	</div>
+	<div class="pure-u-1 pure-u-md-1-2" lang="en">
+	<div class="lbox">
+		<p>This is work in progress and contributions are welcome. Head over to
+		<a href="https://github.com/PromyLOPh/lulua">GitHub</a> to see where
+		you can help.</a></p>
+	</div>
+	</div>
+</div>
+
+<div class="pure-g flexreverse">
+	<div class="pure-u-1 pure-u-md-1-2">
+	</div>
+	<div class="pure-u-1 pure-u-md-1-2" lang="en">
+	<div class="lbox">
+		<h2>Goals</h2>
+		<ul>
+			<li>Ergonomic typing of unvocalized and vocalized text with 10 fingers</li>
+			<li>Modern Standard Arabic and Quranic Arabic</li>
+			<li>Localized numbers (European/Arabic-Indic)</li>
+			<li>Usable as primary or secondary keyboard</li>
+			<li>Compose-based</li>
+			<li>Support for Markdown, RST, Wikitext and similar markup</li>
+		</ul>
+
+		<p>Other languages using the Arabic alphabet (regional dialects, Urdu,
+		Persian) are explicitly not supported.</p>
+	</div>
+	</div>
+</div>
+
+<div class="pure-g flexreverse">
+	<div class="pure-u-1 pure-u-md-1-2">
+	</div>
+	<div class="pure-u-1 pure-u-md-1-2" lang="en">
+	<div class="lbox">
+		<h2>Usage</h2>
+		<dl>
+			<dt>Linux</dt>
+			<dd><code>xmodmap <a href="ar-lulua.xmodmap">ar-lulua.xmodmap</a></code></dd>
+		</dl>
+	</div>
+	</div>
+</div>
+
+</body>
+</html>
diff --git a/doc/lulua-logo.svg b/doc/lulua-logo.svg
new file mode 100644
index 0000000..9f078c0
--- /dev/null
+++ b/doc/lulua-logo.svg
@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   width="25.36014mm"
+   height="13.828889mm"
+   viewBox="0 0 25.36014 13.828889"
+   version="1.1"
+   id="svg8">
+  <defs
+     id="defs17" />
+  <metadata
+     id="metadata5">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     style="fill:#ffffff"
+     id="g50">
+    <g
+       aria-label="لؤلؤ"
+       transform="matrix(0.26458333,0,0,0.26458333,-10.208781,-21.74248)"
+       style="font-style:normal;font-variant:normal;font-weight:100;font-stretch:normal;font-size:53.33333588px;line-height:100%;font-family:'IBM Plex Arabic';-inkscape-font-specification:'IBM Plex Arabic, Thin';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-feature-settings:normal;text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       id="flowRoot10">
+      <path
+         d="m 125.36706,120.94964 0.53333,-0.53334 h 0.21333 q 3.73334,0 5.49334,-1.65333 1.76,-1.70667 1.76,-5.38667 V 82.176302 h 1.06666 V 113.3763 q 0,4.26667 -2.02666,6.29334 -1.97334,1.97333 -6.29334,1.97333 h -0.74666 z"
+         id="path852"
+         style="fill:#ffffff" />
+      <path
+         d="m 104.07539,133.2163 h 4.05334 q 6.34666,0 9.70666,-2.88 3.41334,-2.88 4.16,-8.69333 h -8.21333 q -4.21333,0 -6.45333,-2.24 -2.18667,-2.24 -2.18667,-6.29333 0,-2.4 0.64,-4.53334 0.69333,-2.13333 1.86667,-3.68 1.22666,-1.6 2.88,-2.50666 1.65333,-0.96 3.62666,-0.96 4.32,0 6.72,4.10666 2.4,4.05334 2.4,11.36 0,1.92 -0.16,3.52 h 2.82667 v 0.69334 l -0.53333,0.53333 h -2.45334 q -0.90666,6.61333 -4.53333,9.70667 -3.57333,3.09333 -10.29333,3.09333 h -4.05334 z m 2.13334,-20.10666 q 0,3.52 1.81333,5.44 1.86667,1.86666 5.38667,1.86666 h 8.69333 q 0.0533,-0.58666 0.0533,-1.17333 0.0533,-0.64 0.0533,-1.28 v -2.13333 q 0,-2.88 -0.58667,-5.28 -0.53333,-2.45334 -1.6,-4.21334 -1.01333,-1.76 -2.56,-2.72 -1.49333,-0.96 -3.41333,-0.96 -1.65334,0 -3.09334,0.8 -1.44,0.8 -2.50666,2.24 -1.01334,1.38667 -1.65334,3.30667 -0.58666,1.86667 -0.58666,4.10667 z m 3.09333,-16.90667 h 2.66667 l 0.0533,-0.16 q -0.85333,-0.746667 -1.33333,-1.706667 -0.42667,-0.96 -0.42667,-1.973334 0,-1.866666 1.22667,-3.04 1.22666,-1.226667 3.09333,-1.226667 2.24,0 3.68,1.866667 l -0.69333,0.746667 q -1.01334,-1.546667 -2.98667,-1.546667 -1.44,0 -2.4,0.906667 -0.96,0.906667 -0.96,2.293333 0,1.6 1.28,2.666667 1.28,1.066667 3.25333,1.066667 h 3.2 v 1.066667 h -9.65333 z"
+         id="path854"
+         style="fill:#ffffff" />
+      <path
+         d="m 88.075391,120.94964 0.533334,-0.53334 h 0.213333 q 3.733333,0 5.493334,-1.65333 1.76,-1.70667 1.76,-5.38667 V 82.176302 h 1.066666 V 113.3763 q 0,4.26667 -2.026666,6.29334 -1.973334,1.97333 -6.293334,1.97333 h -0.746667 z"
+         id="path856"
+         style="fill:#ffffff" />
+      <path
+         d="m 66.783725,133.2163 h 4.053334 q 6.346667,0 9.706667,-2.88 3.413334,-2.88 4.16,-8.69333 h -8.213333 q -4.213334,0 -6.453334,-2.24 -2.186667,-2.24 -2.186667,-6.29333 0,-2.4 0.64,-4.53334 0.693334,-2.13333 1.866667,-3.68 1.226667,-1.6 2.88,-2.50666 1.653334,-0.96 3.626667,-0.96 4.32,0 6.72,4.10666 2.4,4.05334 2.4,11.36 0,1.92 -0.16,3.52 h 2.826667 v 0.69334 l -0.533333,0.53333 h -2.453334 q -0.906666,6.61333 -4.533333,9.70667 -3.573334,3.09333 -10.293334,3.09333 h -4.053334 z m 2.133334,-20.10666 q 0,3.52 1.813333,5.44 1.866667,1.86666 5.386667,1.86666 h 8.693334 q 0.05333,-0.58666 0.05333,-1.17333 0.05333,-0.64 0.05333,-1.28 v -2.13333 q 0,-2.88 -0.586667,-5.28 -0.533333,-2.45334 -1.6,-4.21334 -1.013333,-1.76 -2.56,-2.72 -1.493334,-0.96 -3.413334,-0.96 -1.653333,0 -3.093333,0.8 -1.44,0.8 -2.506667,2.24 -1.013333,1.38667 -1.653333,3.30667 -0.586667,1.86667 -0.586667,4.10667 z m 3.093333,-16.90667 h 2.666667 l 0.05333,-0.16 q -0.853334,-0.746667 -1.333334,-1.706667 -0.426667,-0.96 -0.426667,-1.973334 0,-1.866666 1.226667,-3.04 1.226667,-1.226667 3.093334,-1.226667 2.24,0 3.68,1.866667 l -0.693334,0.746667 q -1.013333,-1.546667 -2.986666,-1.546667 -1.44,0 -2.4,0.906667 -0.960001,0.906667 -0.960001,2.293333 0,1.6 1.280001,2.666667 1.28,1.066667 3.253333,1.066667 h 3.2 v 1.066667 h -9.653334 z"
+         id="path858"
+         style="fill:#ffffff" />
+    </g>
+    <g
+       style="fill:#ffffff"
+       id="g38">
+      <g
+         style="fill:#ffffff"
+         transform="translate(-16.828094,-21.74248)"
+         id="g850">
+        <path
+           style="color:#000000;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:medium;line-height:normal;font-family:sans-serif;font-variant-ligatures:normal;font-variant-position:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-alternates:normal;font-feature-settings:normal;text-indent:0;text-align:start;text-decoration:none;text-decoration-line:none;text-decoration-style:solid;text-decoration-color:#000000;letter-spacing:normal;word-spacing:normal;text-transform:none;writing-mode:lr-tb;direction:ltr;text-orientation:mixed;dominant-baseline:auto;baseline-shift:baseline;text-anchor:start;white-space:normal;shape-padding:0;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;vector-effect:none;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:0.28;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate"
+           d="m 17.96875,26.736328 c -0.629138,0 -1.140625,0.511487 -1.140625,1.140625 v 3.339844 c 0,0.629138 0.511487,1.140625 1.140625,1.140625 h 3.339844 c 0.629138,0 1.138672,-0.511487 1.138672,-1.140625 v -3.339844 c 0,-0.629138 -0.509534,-1.140625 -1.138672,-1.140625 z m 0,0.28125 h 3.339844 c 0.478861,0 0.859375,0.380514 0.859375,0.859375 v 3.339844 c 0,0.478861 -0.380514,0.859375 -0.859375,0.859375 H 17.96875 c -0.478862,0 -0.861328,-0.380514 -0.861328,-0.859375 v -3.339844 c 0,-0.478861 0.382466,-0.859375 0.861328,-0.859375 z"
+           id="rect18" />
+        <g
+           aria-label="ة"
+           transform="matrix(0.26458333,0,0,0.26458333,-0.33187688,-0.20666021)"
+           style="font-style:normal;font-variant:normal;font-weight:100;font-stretch:normal;font-size:53.33333588px;line-height:100%;font-family:'IBM Plex Arabic';-inkscape-font-specification:'IBM Plex Arabic, Thin';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-feature-settings:normal;text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+           id="flowRoot842" />
+      </g>
+      <rect
+         y="9.2311716"
+         x="1.6189767"
+         height="0.32543749"
+         width="2.3812499"
+         id="rect825"
+         style="opacity:1;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:0.28;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
+    </g>
+  </g>
+</svg>
diff --git a/doc/style.css b/doc/style.css
new file mode 100644
index 0000000..995be7a
--- /dev/null
+++ b/doc/style.css
@@ -0,0 +1,88 @@
+@font-face {
+  font-family: 'IBM Plex Arabic';
+  font-style: normal;
+  font-weight: 100;
+  src: local('IBM Plex Arabic Thin'), local('IBM Plex Arabic-Thin'), url('fonts/IBMPlexArabic-Thin.woff2') format('woff2');
+}
+
+@font-face {
+  font-family: 'IBM Plex Arabic';
+  font-style: normal;
+  font-weight: 400;
+  src: local('IBM Plex Arabic Regular'), local('IBM Plex Arabic-Regular'), url('fonts/IBMPlexArabic-Regular.woff2') format('woff2');
+}
+
+body {
+	font-size: 14pt;
+	background-color: #eeeeec;
+	color: #2e3436;
+}
+/* is there a better way to select _both_ fonts at the same time? */
+:lang(ar) {
+	direction: rtl;
+	font-family: "IBM Plex Arabic";
+}
+/* inside ltr text */
+:lang(ar)[dir=ltr] {
+	direction: ltr;
+}
+:lang(en) {
+	direction: ltr;
+	font-family: "IBM Plex Sans";
+}
+h1, h2, h3 {
+	font-weight: 100;
+}
+h2 {
+	font-size: 3em;
+}
+figure {
+	max-width: 70em;
+	margin: 1.3em auto;
+}
+img {
+	width: 100%;
+}
+code {
+	font-family: "IBM Plex Mono", monospace !important; /* override :lang(*) font setting */
+}
+a:link, a:visited {
+	color: #555753;
+	text-decoration: none;
+}
+a:focus, a:hover {
+	background-color: #555753;
+	color: #eeeeec;
+	border-radius: 0.1em;
+}
+div.title-card {
+	background-color: #555753;
+	color: #eeeeec;
+	border-top: 1em solid #888a85;
+}
+div.title-card .lbox {
+	margin: 1em;
+}
+div.title-card h1 {
+	margin: 0;
+	padding: 1em;
+}
+div.title-card img.logo {
+	max-width: 20em;
+	display: block;
+	margin: 0 auto;
+}
+div.title-card .subtitle {
+	padding: 0 0.5em;
+	font-size: 1.5em;
+}
+div.title-card .layout img {
+	display: block;
+	margin: 0 auto;
+}
+.flexreverse {
+	flex-direction: row-reverse;
+}
+.lbox {
+	margin: 0 5vw;
+}