From 037e7cc02b66a54d5dec19a6b93a7bf107a95a0e Mon Sep 17 00:00:00 2001 From: gcontini <1121667+gcontini@users.noreply.github.com> Date: 周六, 28 3月 2020 22:29:12 +0800 Subject: [PATCH] documentation update (win32) and others --- README.md | 34 +++++++++++++++++++--------------- 1 files changed, 19 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index e0a832d..567a849 100644 --- a/README.md +++ b/README.md @@ -10,27 +10,28 @@ [](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. +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](http://open-license-manager.github.io/open-license-manager/analysis/features.html), and their status is available in the project wiki. + +If you plan to use this library or part of it 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> here 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 -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. +Below an overview of the basic build procedure, you can find detailed instructions for [linux](http://open-license-manager.github.io/open-license-manager/development/Build-the-library.html) +or [windows](http://open-license-manager.github.io/open-license-manager/development/Build-the-library-windows.html) in the project web site. ### Prerequisites - Operating system: Linux(Ubuntu, CentOS), Windows @@ -38,7 +39,7 @@ - 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) +For a complete list of dependencies and supported environments see [the wiki](http://open-license-manager.github.io/open-license-manager/development/Dependencies.html) Clone the project. It has submodules, don't forget the `--recursive` option. @@ -91,5 +92,8 @@ ## 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. +The easiest way you can solve your problems or ask help is through the [forum](https://groups.google.com/forum/#!forum/licensecc) (hosted on Google), +otherwise if you think there is a problem you can open an issue in the [issue system](https://github.com/open-license-manager/open-license-manager/issues). +Have a look to the [contribution guidelines](CONTRIBUTING.md) before reporting. +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