From 4965d378fb141a21c8afa7c283a8af4725e6a57e Mon Sep 17 00:00:00 2001 From: nemtrif Date: Sun, 10 Dec 2023 10:41:12 -0500 Subject: [PATCH] Deprecate CMake support Make clear that CMake is not the supported way of installing the library --- CMakeLists.txt | 3 +++ README.md | 9 +++++++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index ce521f8..f252337 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -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 diff --git a/README.md b/README.md index 3dbe4ac..624e848 100644 --- a/README.md +++ b/README.md @@ -112,8 +112,13 @@ I came up with a small, C++98 compatible generic library in order to handle UTF- ## 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. ## Examples of use