From b6725be6ef622fae705f2af06ae1afc6c5f2952c Mon Sep 17 00:00:00 2001
From: Antoine COMBET <antoine.combet@etu.univ-lyon1.fr>
Date: Sat, 18 Dec 2021 15:19:51 +0100
Subject: [PATCH] Init

---
 README.org | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 README.org

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..3c78e56
--- /dev/null
+++ b/README.org
@@ -0,0 +1,33 @@
+#+title: Font thing
+#+author: Antoine "Annwan" COMBET
+
+A small bitmap font renderer with its own format.
+
+* The format
+
+Introducing /TXTF/ a family of text based bitmap font formats.
+
+The first line of a TXTF font is the following:
+#+begin_quote
+=TXTF= /mode/ /nbcommentlines/ /file parameters/
+#+end_quote
+Like
+#+begin_example
+TXTF 1 10 5 5 .#
+#+end_example
+
+The /nbcommentlines/ parameter is the number of description or comment
+lines placed before the actual font data (not including the
+header). In this comment area, you may put stuff like modelines,
+copyright information and/or a description of the font.
+
+The /mode/ is the specific fomat in the txtf familly this file is in,
+the existing mode are as follow
+
+** Mode 1 (Monospace)
+
+#+begin_quote
+=TXTF= =1= /nbcommentlines/ /width/ /height/ /alphabet/
+/Comment lines/
+/Data/
+#+end_quote