diff options
Diffstat (limited to '3rdparty/utf8proc/README.md')
-rw-r--r-- | 3rdparty/utf8proc/README.md | 31 |
1 files changed, 25 insertions, 6 deletions
diff --git a/3rdparty/utf8proc/README.md b/3rdparty/utf8proc/README.md index cb9f69478df..2923e8cde2f 100644 --- a/3rdparty/utf8proc/README.md +++ b/3rdparty/utf8proc/README.md @@ -1,9 +1,8 @@ # utf8proc -[](https://travis-ci.org/JuliaLang/utf8proc) -[](https://ci.appveyor.com/project/tkelman/utf8proc/branch/master) +[](https://github.com/JuliaStrings/utf8proc/actions/workflows/build-ci.yml) +[](https://ci.appveyor.com/project/StevenGJohnson/utf8proc) - -[utf8proc](http://julialang.org/utf8proc/) is a small, clean C +[utf8proc](http://juliastrings.github.io/utf8proc/) is a small, clean C library that provides Unicode normalization, case-folding, and other operations for data in the [UTF-8 encoding](http://en.wikipedia.org/wiki/UTF-8). It was [initially @@ -32,7 +31,27 @@ the included `LICENSE.md` file for more detailed information. ## Quick Start -For compilation of the C library run `make`. +Typical users should download a [utf8proc release](http://juliastrings.github.io/utf8proc/releases/) rather than cloning directly from github. + +For compilation of the C library, run `make`. You can also install the library and header file with `make install` (by default into `/usr/local/lib` and `/usr/local/bin`, but this can be changed by `make prefix=/some/dir`). `make check` runs some tests, and `make clean` deletes all of the generated files. + +Alternatively, you can compile with `cmake`, e.g. by +```sh +mkdir build +cmake -S . -B build +cmake --build build +``` + +### Using other compilers +The included `Makefile` supports GNU/Linux flavors and MacOS with `gcc`-like compilers; Windows users will typically use `cmake`. + +For other Unix-like systems and other compilers, you may need to pass modified settings to `make` in order to use the correct compilation flags for building shared libraries on your system. + +For HP-UX with HP's `aCC` compiler and GNU Make (installed as `gmake`), you can compile with +``` +gmake CC=/opt/aCC/bin/aCC CFLAGS="+O2" PICFLAG="+z" C99FLAG="-Ae" WCFLAGS="+w" LDFLAG_SHARED="-b" SOFLAG="-Wl,+h" +``` +To run `gmake install` you will need GNU coreutils for the `install` command, and you may want to pass `prefix=/opt libdir=/opt/lib/hpux32` or similar to change the installation location. ## General Information @@ -40,7 +59,7 @@ The C library is found in this directory after successful compilation and is named `libutf8proc.a` (for the static library) and `libutf8proc.so` (for the dynamic library). -The Unicode version supported is 9.0.0. +The Unicode version supported is 15.1.0. For Unicode normalizations, the following options are used: |