diff options
| author | Egor Tensin <Egor.Tensin@gmail.com> | 2021-09-27 16:55:40 +0300 |
|---|---|---|
| committer | Egor Tensin <Egor.Tensin@gmail.com> | 2021-09-27 17:10:56 +0300 |
| commit | 04dc86e36b745af83d6c49c67e0f88e8752f8f76 (patch) | |
| tree | e3a7e6acd39f911eb86f41582378f1a4b3613702 /README.md | |
| parent | test: add a test case for literal values (diff) | |
| download | winapi-utf8-04dc86e36b745af83d6c49c67e0f88e8752f8f76.tar.gz winapi-utf8-04dc86e36b745af83d6c49c67e0f88e8752f8f76.zip | |
README: update
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 19 insertions, 0 deletions
@@ -5,6 +5,23 @@ winapi-utf8 UTF-8 <-> UTF-16 conversion functions, mainly to be used with WinAPI. +Usage +----- + +Include it in your CMake project and link to the `winapi_utf8` target. +Use the `narrow()` and `widen()` functions to convert to UTF-8 and UTF-16 +respectively: + + #include <winapi/utf8.hpp> + + winapi::narrow(u"Привет"); // Returns the UTF-8 representation + winapi::widen(u8"Привет"); // Returns the UTF-16 representation + +See the various convenience overloads of these function in the +[online documentation]. + +[online documentation]: https://egor-tensin.github.io/winapi-utf8/utf8_8hpp.html + Development ----------- @@ -27,6 +44,8 @@ Build & display the documentation using make docs +View the online documentation at https://egor-tensin.github.io/winapi-utf8/. + License ------- |