From 9d7cd404cc2d09c82b65be4828be0ac74eca20a7 Mon Sep 17 00:00:00 2001
From: gcontini <1121667+gcontini@users.noreply.github.com>
Date: 周三, 01 1月 2020 20:26:43 +0800
Subject: [PATCH] cleanup & new api
---
README.md | 34 ++++++++++++++++++----------------
1 files changed, 18 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index 2d6475f..e55936b 100644
--- a/README.md
+++ b/README.md
@@ -7,31 +7,32 @@
[](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: . 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.
+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:
+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 generator lcc-license-generator `lcc` for customizing the library and generate the licenses.
+- 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.
-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
+## 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.
-## Prerequisites
+### 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)
@@ -47,7 +48,7 @@
cd build
```
-## build on Linux
+### build on Linux
```console
cmake .. -DCMAKE_INSTALL_PREFIX=../install
@@ -55,14 +56,14 @@
make install
```
-## build 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
@@ -89,5 +90,6 @@
The [examples](https://github.com/open-license-manager/examples) repository that shows various ways to integrate `open-licence-manager` into your project.
## 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](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