From 91e1b0675d531e87a8866ab6595692a3fa52c322 Mon Sep 17 00:00:00 2001
From: Gabriele Contini <gcontini@users.noreply.github.com>
Date: 周六, 14 12月 2019 13:56:41 +0800
Subject: [PATCH] Merge pull request #69 from open-license-manager/feature/issue_licenses_42
---
README.md | 73 ++++++++++++++++--------------------
1 files changed, 32 insertions(+), 41 deletions(-)
diff --git a/README.md b/README.md
index 72838b4..c10ad1c 100644
--- a/README.md
+++ b/README.md
@@ -1,63 +1,67 @@
# Open License Manager
-[](https://travis-ci.org/open-license-manager/open-license-manager)
-[](http://github.com/badges/stability-badges)[](https://opensource.org/licenses/BSD-3-Clause)
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)
+[](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)
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
virtualized environments. It is an Open License Manager that helps to keep your
software closed :smirk: . A comprehensive [list of features](https://github.com/open-license-manager/open-license-manager/wiki/features), and their status is available in the project wiki.
-## License
+##License
The project is donated to the community. It comes with a very large freedom of use for everyone, and it will always be.
It uses a [BSD 3 clauses](https://opensource.org/licenses/BSD-3-Clause) licensing schema, that allows free modification and inclusion in commercial software.
-
## Project Structure
The software is made by 2 main sub-components:
- * a C library with no (or minimal) external dependencies (the part you have to integrate in your software).
- * a license generator written in C++ (allows you to generate a license).
+* 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.
-
-You can notice 2 more sub-projects:
- * bootstrap: allows to generate private keys and modify the library on the fly after the downloading.
- * testing : runs the tests (and publish the results on cdash)
+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 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.
-Below an overview of the basic build procedure, you can find detailed instructions for each [supported environment](https://github.com/open-license-manager/open-license-manager/wiki/Build-the-library) in the wiki.
+## 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.
-## prerequisites
- * compilsers: GCC (Linux) MINGW (Linux cross compile for Windows), MINGW or MSVC (Windows)
- * tools/libs: cmake, boost. If target is linux openssl is necessary.
+For a complete list of dependencies and supported environments see [the wiki](https://github.com/open-license-manager/open-license-manager/wiki/Dependencies)
-```
-git clone https://github.com/open-license-manager/open-license-manager.git
+Clone the project. It has submodules, don't forget the `--recursive` option.
+
+```console
+git clone --recursive https://github.com/open-license-manager/open-license-manager.git
cd open-license-manager/
-mkdir build
cd build
```
## on Linux
-```
+```console
cmake .. -DCMAKE_INSTALL_PREFIX=../install
make
make install
```
## on Windows (with MSVC 2015)
-```
+```console
cmake .. -G "Visual Studio 14 2015 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
@@ -67,34 +71,21 @@
===========
## on Linux
-```
+```console
make test
```
## on Windows (MSVC)
-```
+```console
ctest -C Release
```
How to use
==========
-This simple example shows how to integrate open-licence-manager into your project
+The [examples](https://github.com/open-license-manager/examples) repository that shows various ways to integrate `open-licence-manager` into your project.
-```
-$ cd example
-$ cmake .
-$ make
-$ ./example
-license ERROR :
- license file not found
-the pc signature is :
- Jaaa-aaaa-MG9F-ZhBB
-$ ../install/bin/license_generator example -s Jaaa-aaaa-MG9F-ZhBB -o example.lic
-$ ./example
-licence OK
-```
# 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