summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSteven G. Johnson <stevenj@mit.edu>2014-07-15 21:50:23 -0400
committerSteven G. Johnson <stevenj@mit.edu>2014-07-15 21:50:23 -0400
commite41bd981cbc2242b5e44da0bef48fd0f57065fed (patch)
tree09c50d951da00655884a0900e10d0a28e8a65e7a /README.md
parent0d7224a6d8a77e5eebf5e18bded742490f3b20fd (diff)
downloadlibutf8proc-e41bd981cbc2242b5e44da0bef48fd0f57065fed.tar.gz
libutf8proc-e41bd981cbc2242b5e44da0bef48fd0f57065fed.tar.bz2
markdown fixes, prettified NEWS
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/README.md b/README.md
index e0efefc..babc9b8 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-== libutf8proc ==
+# libutf8proc #
The [libutf8proc package](https://github.com/JuliaLang/libutf8proc) is
a lightly updated fork of the [utf8proc
@@ -28,11 +28,11 @@ data governed by the similarly permissive [Unicode data
license](http://www.unicode.org/copyright.html#Exhibit1)); please see
the included `LICENSE.md` file for more detailed information.
-=== Quick Start ===
+## Quick Start ##
For compilation of the C library run `make`.
-=== General Information ===
+## General Information ##
The C library is found in this directory after successful compilation
and is named `libutf8proc.a` (for the static library) and
@@ -49,19 +49,19 @@ For Unicode normalizations, the following options are used:
* Normalization Form KC: `STABLE`, `COMPOSE`, `COMPAT`
* Normalization Form KD: `STABLE`, `DECOMPOSE`, `COMPAT`
-=== C Library ===
+## C Library ##
The documentation for the C library is found in the `utf8proc.h` header file.
`utf8proc_map` is function you will most likely be using for mapping UTF-8
strings, unless you want to allocate memory yourself.
-=== To Do ===
+## To Do ##
* detect stable code points and process segments independently in order to save memory
* do a quick check before normalizing strings to optimize speed
* support stream processing
-=== Contact ===
+## Contact ##
Bug reports, feature requests, and other queries can be filed at
the [libutf8proc page on Github](https://github.com/JuliaLang/libutf8proc).