From b916341e22ea64a1141d587e823f052c492cca4c Mon Sep 17 00:00:00 2001
From: Gabriele Contini <contini.mailing@gmail.com>
Date: 周六, 28 12月 2019 09:25:26 +0800
Subject: [PATCH] readme update
---
README.md | 107 +++++++++++++++++++++++++----------------------------
1 files changed, 51 insertions(+), 56 deletions(-)
diff --git a/README.md b/README.md
index 018f818..e55936b 100644
--- a/README.md
+++ b/README.md
@@ -1,100 +1,95 @@
# Open License Manager
-[](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)
-
A copy protection, licensing software written in C++ for Windows and Linux (with a simple C api for use in C projects).
-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.
+[](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)
+[](https://codecov.io/gh/open-license-manager/open-license-manager)
+[](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: . 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.
+
+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.
+
+If you like this library remember to show us your appreciation giving it a
+<a class="github-button" href="https://github.com/open-license-manager/open-license-manager" data-icon="octicon-star" aria-label="Star open-license-manager/open-license-manager on GitHub">star</a> on GitHub.
## 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 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.
+The software is made by 3 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)) `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.
+## 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-windows) in the wiki.
-# 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.
+### 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
-* 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.
+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
+```console
+git clone --recursive https://github.com/open-license-manager/open-license-manager.git
cd open-license-manager/
-mkdir build
cd build
```
-## on Linux
-```
+### build on Linux
+
+```console
cmake .. -DCMAKE_INSTALL_PREFIX=../install
make
make install
```
-## on Windows (with MSVC 2015)
-```
+### build 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
-```
+### cross compile with MINGW on Linux
+
+```console
x86_64-w64-mingw32.static-cmake .. -DCMAKE_INSTALL_PREFIX=../install
make
make install
```
-How to test
-===========
+## How to test
-## on Linux
-```
+### on Linux
+
+```console
make test
```
-## on Windows (MSVC)
-```
+### on Windows (MSVC)
+
+```console
ctest -C Release
```
-How to use
-==========
+## 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
-# 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