]> code.bitgloo.com Git - clyne/arabtype.git/commitdiff
Update README.md
authorWael El Oraiby <wael.eloraiby@gmail.com>
Sun, 31 Jan 2016 01:42:20 +0000 (20:42 -0500)
committerWael El Oraiby <wael.eloraiby@gmail.com>
Sun, 31 Jan 2016 01:42:20 +0000 (20:42 -0500)
README.md

index c33f34cd86acedca953c42d33fe96a893c301bd9..541d0804eb1515c838ae7b8cfd4b30488a9c841d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-<U><B>Arabtype</B></U>
+# Arabtype
 
 A small and simple implementation that transform isolated arabic utf8 character
 strings into contextual forms useful for rendering (rendering example is provided).
@@ -7,7 +7,7 @@ This is mostly suitable for lightweight UIs (embedded systems, games, media play
 It's worthy to note that this is far more lightweight than HarfBuzz (used by Qt/Pango...).
 Freetype 2 on the other hand lacks this functionality.
 
-<U><B>Usage:</B></U>
+### Usage
 
 One call will convert a utf8 string to a sequence of code points:
 
@@ -30,16 +30,16 @@ Where
 
 `return`: return the total number of code points transformed
 
-<U><B>Details:</B></U>
+### Details
 Arabic letters have 4 forms: Isolated, Initial, Medial and Ending. An arabic letter will have one of these forms depending on the letters preceding and succeeding it: For instance take the letter ﺡ : This is the isolated form (i.e. nothing precedes nor succeeds it), if it comes at the start of a syllable it will have the initial form ( ﺣ ). If it ends a syllable it will have the ending form ( ﺢ ) and if it is in the middle of a syllable it will have the medial form ( ﺤ ).  Some even have more complicated ligature forms (such as Lam and Alef together: ﻻ ) . A utf8 arabic string usually only comprises of isolated letters from [Arabic Unicode Block](http://en.wikipedia.org/wiki/Arabic_%28Unicode_block%29). With this library you will transform it to the rendering/presentation form: [Arabic Presentation Forms B](http://en.wikipedia.org/wiki/Arabic_Presentation_Forms-B)
 
 
-<U><B>Example ([Khalil Gibran](http://en.wikipedia.org/wiki/Kahlil_Gibran)'s Al-Nay):</B></U>
+### Example ([Khalil Gibran](http://en.wikipedia.org/wiki/Kahlil_Gibran)'s Al-Nay)
 
 ![ScreenShot](https://raw.github.com/eloraiby/arabtype/master/example.png)
 
 
-<U><B>LICENSE:</B></U>
+### LICENSE
 
 Arabtype, Copyrights 2012-2015(c) Wael El Oraiby. All rights reserved.