From 8d405b265285c368df2e9cf1c14acee7532e0ee7 Mon Sep 17 00:00:00 2001
From: nancy.liao <huihui.liao@greentest.com.cn>
Date: ćšć, 29 5æ 2025 18:14:38 +0800
Subject: [PATCH] Merge branch 'develop' of http://139.9.88.116:3000/r/module/open-license-manager into develop
---
README.md | 106 ++++++++++++++++++++++++++++++++++++++++++++++++-----
1 files changed, 96 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 0239917..cbe5f0d 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,100 @@
-license-manager-cpp
-===================
+# Licensecc
-A lincense manager written in C++
+*Copy protection, licensing library and license generator for Windows and Linux.*
-Linux
-===================
+[](https://en.wikipedia.org/wiki/C%2B%2B#Standardization)
+[](http://github.com/badges/stability-badges)
+[](https://opensource.org/licenses/BSD-3-Clause)
+[](https://travis-ci.org/open-license-manager/licensecc)
+[](https://github.com/open-license-manager/licensecc/actions)
+[](https://www.codacy.com/gh/open-license-manager/licensecc/dashboard?utm_source=github.com&utm_medium=referral&utm_content=open-license-manager/licensecc&utm_campaign=Badge_Grade)
+[](https://codecov.io/gh/open-license-manager/licensecc)
+[](http://github.com/open-license-manager/licensecc/issues)
-apt-get install libcrypto++dev (version 5.6.1)
-libboost-dev libboost-filesystem-dev
-libboost-program-options-dev libboost-test-dev libboost-date-time-dev
-libssl-dev?
+Protect the software you develop from unauthorized copies, limit the usage in time, to a specific set of
+machines, or prevent the usage in virtualized environments. It is an open source license manager that helps to keep your
+software closed :smirk: . Among other features if it runs on a "real hardware" it can generate a signature of that hardware and report if the signature doesn't match.
-openssl genrsa -out src/license-generator/privkey.pem 2048
\ No newline at end of file
+A comprehensive [list of features](http://open-license-manager.github.io/licensecc/analysis/features.html), and their status is available in the project site.
+
+If you're experiencing problems, or you just need informations you can't find in the [documentation](http://open-license-manager.github.io/licensecc) please contact us on [github discussions](https://github.com/open-license-manager/licensecc/discussions), we'll be happy to help.
+
+Remember to show your appreciation giving us a <a class="github-button" href="https://github.com/open-license-manager/licensecc" data-icon="octicon-star" aria-label="Star open-license-manager/licensecc on GitHub">star</a> here on GitHub.
+
+## License
+The project is donated to the community. It comes with freedom of use for everyone, and it always will be.
+It has a [BSD 3 clauses](https://opensource.org/licenses/BSD-3-Clause) licensing schema, that allows free modification and use in commercial software.
+
+## Project Structure
+The software is made by 4 main sub-components:
+- a C++ library with a nice C api, `licensecc` with minimal (or no) external dependencies (the part you have to integrate in your software) that is the project you're currently in.
+- a license debugger `lcc-inspector` to be sent to the final customer when there are licensing problems or for calculating the pc hash before issuing the license.
+- a license generator (github project [lcc-license-generator](https://github.com/open-license-manager/lcc-license-generator)) `lccgen` for customizing the library and generate the licenses.
+- Usage [examples](https://github.com/open-license-manager/examples) to simplify the integration in your project.
+
+## How to build
+Below an overview of the basic build procedure, you can find detailed instructions for [Linux](http://open-license-manager.github.io/licensecc/development/Build-the-library.html)
+or [Windows](http://open-license-manager.github.io/licensecc/development/Build-the-library-windows.html) in the project web site.
+
+### Prerequisites
+- Operating system: Linux(Ubuntu, CentOS), Windows
+- compilers : GCC (Linux) MINGW (Linux cross compile for Windows), MINGW or MSVC (Windows)
+- tools : cmake(>3.6), git, make/ninja(linux)
+- libs : If target is Linux Openssl is required. Windows depends only on system libraries. Boost is necessary to build license generator and to run the tests but it's NOT a dependency of the final `licensecc` library.
+
+For a complete list of dependencies and supported environments see [the project website](http://open-license-manager.github.io/licensecc/development/Dependencies.html)
+
+Clone the project. It has submodules, don't forget the `--recursive` option.
+
+```console
+git clone --recursive https://github.com/open-license-manager/licensecc.git
+cd licensecc/build
+```
+
+### build on Linux
+
+```console
+cmake .. -DCMAKE_INSTALL_PREFIX=../install
+make
+make install
+```
+
+### build on Windows (with MSVC 2017)
+
+```console
+cmake .. -G "Visual Studio 15 2017 Win64" -DBOOST_ROOT="{Folder where boost is}" -DCMAKE_INSTALL_PREFIX=../install
+cmake --build . --target install --config Release
+```
+
+### cross compile with MINGW on Linux
+
+```console
+x86_64-w64-mingw32.static-cmake .. -DCMAKE_INSTALL_PREFIX=../install
+make
+make install
+```
+
+## How to test
+
+### on Linux
+
+```console
+make test
+```
+
+### on Windows (MSVC)
+
+```console
+ctest -C Release
+```
+
+## How to use
+
+The [examples](https://github.com/open-license-manager/examples) repository that shows various ways to integrate `licensecc` into your project.
+
+## How to contribute
+
+The easiest way you can solve your problems or ask help is through the [discussions tab](https://github.com/open-license-manager/licensecc/discussions) above, otherwise if you think there is a problem you can open an issue in the [issue system](https://github.com/open-license-manager/licensecc/issues).
+Have a look to the [contribution guidelines](CONTRIBUTING.md) before reporting.
+We use [GitFlow](https://datasift.github.io/gitflow/IntroducingGitFlow.html) (or at least a subset of it).
+Remember to install the gitflow git plugin and use `develop` as default branch for your pull requests.
--
Gitblit v1.9.1