From e3e83c70085d9a9c82b643b46d918fe3a2d21e03 Mon Sep 17 00:00:00 2001 From: Gabriele Contini <contini.mailing@gmail.com> Date: 周六, 14 12月 2019 11:35:52 +0800 Subject: [PATCH] fix windows compilation, better cmake output --- README.md | 38 +++++++++++++++++++++----------------- 1 files changed, 21 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 23aed5b..7041566 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ # Open License Manager +A copy protection, licensing software written in C++ for Windows and Linux (with a simple C api for use in C projects). + [](https://en.wikipedia.org/wiki/C%2B%2B#Standardization) -[](http://github.com/badges/stability-badges)[](https://opensource.org/licenses/BSD-3-Clause) +[](http://github.com/badges/stability-badges) +[](https://opensource.org/licenses/BSD-3-Clause) [](https://travis-ci.org/open-license-manager/open-license-manager) [](https://www.codacy.com/manual/gcontini/open-license-manager?utm_source=github.com&utm_medium=referral&utm_content=open-license-manager/open-license-manager&utm_campaign=Badge_Grade) -[)](http://github.com/open-license-manager/open-license-manager/issues) - -A copy protection, licensing software written in C++ for Windows and Linux (with a simple C api for use in C projects). +[](http://github.com/open-license-manager/open-license-manager/issues) It allows to protect the software you develop from unauthorized copies, limit the usage in time, to a specific set of machines, or prevent the usage in @@ -19,27 +20,30 @@ ## Project Structure The software is made by 2 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). - * a license generator lcc-license-generator `lcc` for customizing the library and generate the licenses. +* 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 generator lcc-license-generator `lcc` for customizing the library and generate the licenses. -these modules are planned.... - * a license [backoffice](../../issues/7) in php (in order to handle multiple licenses). - * a license debugger to be sent to the final customer when there are licensing problems. - * a [log descriptor](../../issues/8) in order to decrypt logs generated by the license system. +The following modules are planned... +* a license [backoffice](../../issues/7) in php (in order to handle multiple licenses). +* a license debugger to be sent to the final customer when there are licensing problems. +* a [log descriptor](../../issues/8) in order to decrypt logs generated by the license system. # How to build -Below an overview of the basic build procedure, you can find [detailed instructions](https://github.com/open-license-manager/open-license-manager/wiki/Build-the-library) for your environment in the wiki. +Below an overview of the basic build procedure, you can find detailed instructions for [linux](https://github.com/open-license-manager/open-license-manager/wiki/Build-the-library) or [windows](https://github.com/open-license-manager/open-license-manager/wiki/Build-the-library-win) in the wiki. ## prerequisites - * compilers: GCC (Linux) MINGW (Linux cross compile for Windows), MINGW or MSVC (Windows) - * tools : cmake, 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 `licensecc` library. +* 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 wiki](https://github.com/open-license-manager/open-license-manager/wiki/Dependencies) + +Clone the project. It has submodules, don't forget the `--recursive` option. ``` -git clone https://github.com/open-license-manager/open-license-manager.git +git clone --recursive https://github.com/open-license-manager/open-license-manager.git cd open-license-manager/ -mkdir build cd build ``` @@ -96,5 +100,5 @@ ``` # How to contribute -The project is not dead but we take our time to answer. The best interaction you can have with us is through the issue system. Have a look to the [contribution guidelines](blob/develop/CONTRIBUTING.md) +The project is not dead but we take our time to answer. The best interaction you can have with us is through the issue system. Have a look to the [contribution guidelines](CONTRIBUTING.md) 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