aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2022-07-18 22:24:15 +0200
committerMattias Andrée <maandree@kth.se>2022-07-18 22:24:15 +0200
commitb8f6cd0810ea311f71576f7954ba24e1f6e42b9d (patch)
tree4b4671486b099fe5ffa2e5c95c916beab5163125
parentAdd documentation to the header file (diff)
downloadlibtracebitmap-b8f6cd0810ea311f71576f7954ba24e1f6e42b9d.tar.gz
libtracebitmap-b8f6cd0810ea311f71576f7954ba24e1f6e42b9d.tar.bz2
libtracebitmap-b8f6cd0810ea311f71576f7954ba24e1f6e42b9d.tar.xz
Improve README
Signed-off-by: Mattias Andrée <maandree@kth.se>
-rw-r--r--README14
1 files changed, 12 insertions, 2 deletions
diff --git a/README b/README
index 82fd4d8..ff5acb3 100644
--- a/README
+++ b/README
@@ -1,2 +1,12 @@
-Library for tracing bitmaps (black-and-white pictures) into vectors.
-This is primarily intented for converting bitmap fonts into vector fonts.
+NAME
+ libtracebitmap - Bitmap vectorisation library
+
+DESCRIPTION
+ libtracebitmap is a C library for tracing bitmaps
+ (monochrome raster images) into vectors, and is
+ primarily intented for converting bitmap fonts into
+ vector fonts, and will therefore only create horizontal
+ and vertical vectors.
+
+SEE ALSO
+ None.