From 0ec4d68600b83d41d2e48ad35d18e2a00f234619 Mon Sep 17 00:00:00 2001
From: gcontini <1121667+gcontini@users.noreply.github.com>
Date: 周六, 21 9月 2019 01:34:22 +0800
Subject: [PATCH] Merge branch 'develop' of https://github.com/open-license-manager/open-license-manager into develop
---
README.md | 96 ++++++++++++++++++++++++++++++++++++++++-------
1 files changed, 81 insertions(+), 15 deletions(-)
diff --git a/README.md b/README.md
index 5ba2f40..3b096d7 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,20 @@
# 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 lincense manager written in C/C++ for Windows and Linux environments.
+A copy protection, licensing software written in C/C++ for Windows and Linux.
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 ;-)
+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
+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).
@@ -15,20 +22,79 @@
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 decriptor](../../issues/8) in order to decrypt logs generated by the license system.
+ * 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)
-
-Licensing
-=====================
-The project comes out with a very large freedom of use for everyone (and it will always be).
-It uses a BSD 3 clauses licensing schema.
-Elsewhere on Internet
-=====================
- * Wiki main page:
- * Install and build :
- * Project web site :
-
\ No newline at end of file
+# How to build
+
+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
+ * compilsers: GCC (Linux) MINGW (Linux cross compile for Windows), MINGW or MSVC (Windows)
+ * tools/libs: cmake, boost. If target is linux openssl is necessary.
+
+```
+git clone https://github.com/open-license-manager/open-license-manager.git
+cd open-license-manager/
+mkdir build
+cd build
+```
+
+## on Linux
+```
+cmake .. -DCMAKE_INSTALL_PREFIX=../install
+make
+make install
+```
+
+## on Windows (with MSVC 2015)
+```
+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
+```
+x86_64-w64-mingw32.static-cmake .. -DCMAKE_INSTALL_PREFIX=../install
+make
+make install
+```
+
+How to test
+===========
+
+## on Linux
+```
+make test
+```
+
+## on Windows (MSVC)
+```
+ctest -C Release
+```
+
+How to use
+==========
+
+This simple example shows how 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)
+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