summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/README.md b/README.md
index 006cc49..457e673 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# TrueType font parser.
+# TrueType font parser
Fountainhead is a TrueType and OpenType font parser. Its main
purpose is to extract information from the fonts to help to
@@ -10,24 +10,27 @@ There is also an executable to dump fonts.
## Installation
Add the library as dependency to your project.
-Alternatively build and run the executable with:
+Alternatively build an executable with:
```sh
cabal build
```
-The binary can be executed with:
+The binary can be run with:
```sh
-cabal run fountainhead --
+cabal run fountainhead -- myfont.ttf
```
or installed locally and executed just as:
```sh
-fountainhead
+fountainhead myfont.ttf
```
+This command will output the contents of the font in a format similar to
+ttfdump from TeXLive.
+
See
```sh