1- libuninameslist – A Library of Unicode names and annotation data
2- ================================================================
1+ # libuninameslist – A Library of Unicode names and annotation data
2+
33[ ![ Build status] ( https://ci.appveyor.com/api/projects/status/qseac73evm9leu0g?svg=true )] ( https://ci.appveyor.com/project/fontforge/libuninameslist ) [ ![ Coverity Scan Build Status] ( https://scan.coverity.com/projects/793/badge.svg?flat=1 )] ( https://scan.coverity.com/projects/793 )
44
55- [ Description] ( #description )
@@ -9,10 +9,9 @@ libuninameslist – A Library of Unicode names and annotation data
99- [ Added Python Wrapper] ( #added-python-wrapper )
1010- [ See Also] ( #see-also )
1111
12- Description
13- -----------
12+ ## Description
1413
15- This library is updated for Nameslist.txt ver17.0 and ListeDesNoms .txt ver16.0
14+ This library is updated for Nameslist.txt ver17.0, and ListeNoms .txt ver17.0,
1615and includes python wrapper 'uninameslist.py'
1716
1817For latest release, see: https://github.com/fontforge/libuninameslist/releases
@@ -27,10 +26,10 @@ characters.](http://www.unicode.org/Public/UNIDATA/NamesList.html) This library
2726contains a compiled version of this file so that programs can access this data
2827quickly and easily.
2928
30- ListeDesNoms .txt
31- Is a seperate file which is translated from Nameslist.txt and was outdated for
29+ ListeNoms .txt
30+ Is a separate file which is translated from Nameslist.txt and was outdated for
3231a period of time but was recently updated by a group of developers who have
33- updated it up to version 16 . This requires a large amount of work by them and
32+ updated it up to version 17 . This requires a large amount of work by them and
3433the Contributors to that file are listed in that file.
3534
3635These libraries contain very large (sparse) arrays with one entry for each
@@ -141,8 +140,25 @@ strip available, you can run:
141140$ sudo make install-strip
142141```
143142
144- Installation and Build Instructions
145- -----------------------------------
143+ For a more visual view of what is described above, it looks more like this:
144+ ![ ] ( libs.gif )
145+ So, if built with ` ./configure ` , then only libuninameslist is built, there is
146+ no libuninameslist-fr, and any function calls to other libraries return nothing.
147+
148+ If built with ` ./configure --enable-frenchlib ` , then both libraries are built.
149+ - Older programs(1,2,3) like FontForge (up to 20120713) or UMap can access
150+ libuninameslist or libuninameslist-fr using older access, or newer function calls.
151+ - Newer programs(4) can access all libraries through libuninameslist
152+
153+ Last, but not least, do not mix and match. If you build libuninameslist with
154+ ` ./configure --enable-frenchlib ` , you also need to install libuninameslist-fr
155+ since libuninameslist expects libuninameslist-fr to exist. If you build with
156+ ` ./configure ` , then libuninameslist uses internal stub functions to return NULL
157+ and does not look for libuninameslist-fr; in this case, you can also have
158+ libuninameslist-fr installed too if you want (Program4 can access libuninameslist
159+ but cannot access libuninameslist-fr through libuninameslist).
160+
161+ ## Installation and Build Instructions
146162
147163Download a tagged release version from https://github.com/fontforge/libuninameslist/releases
148164``` bash
180196NOTE: Users who do not have autoconf and automake available will want to
181197download the '-dist-' version found in the releases directory.
182198
183- Optional French Library
184- -----------------------
199+ ## Optional French Library
185200
186201The French library was build as a separate library to maintain backwards with
187202older (...2012) versions of FontForge. If you want to add libuninameslist-fr,
@@ -214,8 +229,7 @@ on the French library, while at the same time older programs (like older
214229FontForge) would load these independently (the dependency is to allow for
215230substitutions if/where/when necessary).
216231
217- Added Python Wrapper
218- --------------------
232+ ## Added Python Wrapper
219233
220234A 'uninameslist.py' Python wrapper is provided for users that want quick
221235NamesList.txt access using python. To do this, you need to first build and
248262$
249263```
250264
251- Note, some operating systems may need to use './configure --prefix=/usr'
265+ NOTE: Some operating systems may need to use './configure --prefix=/usr'
252266
253267The Python wrapper exposes the following library functions and symbols:
254268
@@ -267,8 +281,7 @@ The Python wrapper exposes the following library functions and symbols:
267281Blocks can be iterated over to yield all characters encoded in them.
268282
269283
270- See Also
271- --------
284+ # # See Also
272285
273286- [FontForge Users](https:// sourceforge.net/ p/ fontforge/ mailman/ fontforge- users/ ) - Discussion area for users.
274287- [FontForge](http:// github.com/ fontforge/ fontforge/ ) - font editor application that this library was made for .
0 commit comments