From d52d30566f248fb6bd7b43dd4b7db76a26e02ea3 Mon Sep 17 00:00:00 2001 From: Gabriele Contini <contini.mailing@gmail.com> Date: 周六, 14 12月 2019 14:23:27 +0800 Subject: [PATCH] fix codacy warnings --- README.md | 37 ++++++++++++------------------------- 1 files changed, 12 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 7041566..9aeba93 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ 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) +[](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) @@ -14,7 +14,7 @@ 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. @@ -25,13 +25,13 @@ 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 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 [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) @@ -41,27 +41,27 @@ 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/ 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 @@ -71,33 +71,20 @@ =========== ## 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](CONTRIBUTING.md) -- Gitblit v1.9.1