From 54411ed70691770ea2f643a3901b33904baef72a Mon Sep 17 00:00:00 2001 From: gcontini <1121667+gcontini@users.noreply.github.com> Date: 周六, 07 9月 2019 22:12:18 +0800 Subject: [PATCH] update contribution and readme with references to wiki --- README.md | 20 ++++++++++++-------- 1 files changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b1961f2..b18f2c7 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,14 @@ 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 the 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). @@ -21,18 +28,15 @@ 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. 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 -GCC (Linux), MINGW or MSVC (Windows) -cmake, boost, openssl (Linux/MINGW), you can find detailed instruction for each [supported environment](https://github.com/open-license-manager/open-license-manager/wiki/Build-the-library) in the wiki. Below an overview of the basic build procedure: + * compilsers: GCC (Linux), MINGW or MSVC (Windows) + * tools/libs: cmake, boost, openssl (Linux/MINGW). ``` git clone https://github.com/open-license-manager/open-license-manager.git -- Gitblit v1.9.1