From 7c2489cc3dc798484e11a449fd0e305210de901b Mon Sep 17 00:00:00 2001
From: gcontini <1121667+gcontini@users.noreply.github.com>
Date: 周六, 14 12月 2019 20:12:41 +0800
Subject: [PATCH] fix codacy warnings
---
README.md | 42 ++++++++++++++++++++++--------------------
1 files changed, 22 insertions(+), 20 deletions(-)
diff --git a/README.md b/README.md
index 9aeba93..2d6475f 100644
--- a/README.md
+++ b/README.md
@@ -14,28 +14,28 @@
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.
## 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) that is the project you're currently in.
-* a license generator lcc-license-generator `lcc` for customizing the library and generate the licenses.
+- 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.
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.
+- 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.
## 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.
+- 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.
For a complete list of dependencies and supported environments see [the wiki](https://github.com/open-license-manager/open-license-manager/wiki/Dependencies)
@@ -47,45 +47,47 @@
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
+
```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
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
+## 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