diff options
| author | Steven G. Johnson <stevenj@mit.edu> | 2014-07-15 16:04:36 -0400 |
|---|---|---|
| committer | Steven G. Johnson <stevenj@mit.edu> | 2014-07-15 16:04:36 -0400 |
| commit | 0d7224a6d8a77e5eebf5e18bded742490f3b20fd (patch) | |
| tree | 18fea4ba0497978163668ff85be94d3a717a9fa8 /README | |
| parent | c0f2b512a055c667cb751ef4526ea744f2428826 (diff) | |
| download | libutf8proc-0d7224a6d8a77e5eebf5e18bded742490f3b20fd.tar.gz libutf8proc-0d7224a6d8a77e5eebf5e18bded742490f3b20fd.tar.bz2 | |
markdown and other cosmetic updates
Diffstat (limited to 'README')
| -rw-r--r-- | README | 63 |
1 files changed, 0 insertions, 63 deletions
@@ -1,63 +0,0 @@ - -Please read the LICENSE file, which is shipping with this software. - - -*** QUICK START *** - -For compilation of the C library call "make c-library", for compilation of -the ruby library call "make ruby-library" and for compilation of the -PostgreSQL extension call "make pgsql-library". - -For ruby you can also create a gem-file by calling "make ruby-gem". - -"make all" can be used to build everything, but both ruby and PostgreSQL -installations are required in this case. - - -*** GENERAL INFORMATION *** - -The C library is found in this directory after successful compilation and -is named "libutf8proc.a" and "libutf8proc.so". The ruby library consists of -the files "utf8proc.rb" and "utf8proc_native.so", which are found in the -subdirectory "ruby/". If you chose to create a gem-file it is placed in the -"ruby/gem" directory. The PostgreSQL extension is named "utf8proc_pgsql.so" -and resides in the "pgsql/" directory. - -Both the ruby library and the PostgreSQL extension are built as stand-alone -libraries and are therefore not dependent the dynamic version of the -C library files, but this behaviour might change in future releases. - -The Unicode version being supported is 5.0.0. -Note: Version 4.1.0 of Unicode Standard Annex #29 was used, as - version 5.0.0 had not been available at the time of implementation. - -For Unicode normalizations, the following options have to be used: -Normalization Form C: STABLE, COMPOSE -Normalization Form D: STABLE, DECOMPOSE -Normalization Form KC: STABLE, COMPOSE, COMPAT -Normalization Form KD: STABLE, DECOMPOSE, COMPAT - - -*** C LIBRARY *** - -The documentation for the C library is found in the utf8proc.h header file. -"utf8proc_map" is most likely function you will be using for mapping UTF-8 -strings, unless you want to allocate memory yourself. - - -*** TODO *** - -- 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 *** - -If you find any bugs or experience difficulties in compiling this software, -please contact us: - -Project page: http://www.public-software-group.org/utf8proc - - |