Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1.73 KB

README.md

File metadata and controls

51 lines (33 loc) · 1.73 KB
Raw

Utf8

This is a library which implements RFC 3629, "UTF-8 (Unicode Transformation Format)".

Usage

The Utf8::Utf8 class is used to encode or decode Unicode "code points", or characters from many different international character sets, in order to store or transmit them across any interface that accepts a sequence of bytes.

Supported platforms / recommended toolchains

This is a portable C++11 library which depends only on the C++11 compiler and standard library, so it should be supported on almost any platform. The following are recommended toolchains for popular platforms.

  • Windows -- Visual Studio (Microsoft Visual C++)
  • Linux -- clang or gcc
  • MacOS -- Xcode (clang)

Building

This library is not intended to stand alone. It is intended to be included in a larger solution which uses CMake to generate the build system and build applications which will link with the library.

There are two distinct steps in the build process:

  1. Generation of the build system, using CMake
  2. Compiling, linking, etc., using CMake-compatible toolchain

Prerequisites

  • CMake version 3.8 or newer
  • C++11 toolchain compatible with CMake for your development platform (e.g. Visual Studio on Windows)

Build system generation

Generate the build system using CMake from the solution root. For example:

mkdir build
cd build
cmake -G "Visual Studio 15 2017" -A "x64" ..

Compiling, linking, et cetera

Either use CMake or your toolchain's IDE to build. For CMake:

cd build
cmake --build . --config Release