organicmaps/utfcpp
13
Fork 0
mirror of https://github.com/nemtrif/utfcpp.git synced 2025-04-04 13:05:06 +00:00
Code Issues 1 Projects Releases Wiki Activity Actions

Deprecate CMake support

Browse source 
Make clear that CMake is not the supported way of installing the library
This commit is contained in:
nemtrif 2023-12-10 10:41:12 -05:00
parent c9733bbe49
commit 4965d378fb
2 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
CMakeLists.txt
View file

@ -1,3 +1,6 @@
# This file is deprecated and will be removed in a future release
# Please see the instructions for installation in README.md file
cmake_minimum_required (VERSION 3.5...3.27)
project (utf8cpp
VERSION 4.0.3

9
README.md
View file

@ -112,8 +112,13 @@ I came up with a small, C++98 compatible generic library in order to handle UTF-
<!-- TOC --><a name="installation"></a>
## Installation
The recommended way to use the library is to download an official release and copy the content of source directory into location of your project's header files.
If you use CMake for your builds, I still recommend just copying the files into your project, but if you want you can use the CMakeList.txt file included in the project.
This is a header-only library and the supported way of deploying it is:
- Download a release from https://github.com/nemtrif/utfcpp/releases into a temporary directory
- Unzip the release
- Copy the content of utfcpp/source file into the directory where you keep include files for your project
The CMakeList.txt file was originally made for testing purposes only, but unfortunatelly over time I accepted contributions that added install target. *This is not a supported way of installing the utfcpp library* and I am considering removing the CMakeList.txt in a future release.
<!-- TOC --><a name="examples-of-use"></a>
## Examples of use