From f4ac5d3822656815708651bb65ea0bd3f338af84 Mon Sep 17 00:00:00 2001 From: Gabriele Contini <contini.mailing@gmail.com> Date: 周六, 07 9月 2019 22:12:18 +0800 Subject: [PATCH] update contribution and readme with references to wiki --- CONTRIBUTING.md | 2 +- README.md | 20 ++++++++++++-------- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8f57634..0f68f3f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -58,7 +58,7 @@ ### Your First Code Contribution -Unsure where to begin contributing to Open License Manager? You can start by looking through the [good first issue](https://github.com/open-license-manager/open-license-manager/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and [`help-wanted`](https://github.com/open-license-manager/open-license-manager/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) issues. +Unsure where to begin contributing to Open License Manager? You can start by looking through the [`good first issue`](https://github.com/open-license-manager/open-license-manager/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and [`help-wanted`](https://github.com/open-license-manager/open-license-manager/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) issues. You can have a look to the project upcoming milestones to see what's going to be implemented soon and what is the project direction. If you decide to contribute on an issue scheduled in the current milestone, comment on the issue first. If the issue is marked as "assigned" there may be already some work done for it. Commenting on the issue will ensure we don't duplicate our work. Also have a look to the branches: there may be a feature branch corresponding to the issue with some work already done. 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