summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..006cc49
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# TrueType font parser.
+
+Fountainhead is a TrueType and OpenType font parser. Its main
+purpose is to extract information from the fonts to help to
+embed these fonts into PDF documents. It also supports dumping
+font information to the screen.
+
+There is also an executable to dump fonts.
+
+## Installation
+
+Add the library as dependency to your project.
+Alternatively build and run the executable with:
+
+```sh
+cabal build
+```
+
+The binary can be executed with:
+
+```sh
+cabal run fountainhead --
+```
+
+or installed locally and executed just as:
+
+```sh
+fountainhead
+```
+
+See
+
+```sh
+fountainhead --help
+```
+
+for help.
+
+## Usage