From af5ad5806a7e385d57109e1630b98c952af04775 Mon Sep 17 00:00:00 2001 From: Gabriele Contini <contini.mailing@gmail.com> Date: ćšć, 12 9æ 2019 23:41:31 +0800 Subject: [PATCH] add contribute section to readme --- README.md | 16 +++++++++------- 1 files changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b18f2c7..42d237e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Open License Manager -[](https://travis-ci.org/open-license-manager/open-license-manager) -[](http://github.com/badges/stability-badges) +[](https://travis-ci.org/open-license-manager/open-license-manager) +[](http://github.com/badges/stability-badges)[](https://opensource.org/licenses/BSD-3-Clause) A copy protection, licensing software written in C/C++ for Windows and Linux. @@ -11,11 +11,10 @@ ## 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. +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 no (or minimal) external dependencies (the part you have to integrate in your software). * a license generator written in C++ (allows you to generate a license). @@ -29,8 +28,7 @@ * 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) -How to build -============ +# 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. @@ -54,7 +52,7 @@ ## on Windows (with MSVC 2015) ``` -cmake .. -G "Visual Studio 14 2015 Win64" -DCMAKE_INSTALL_PREFIX=../install +cmake .. -G "Visual Studio 14 2015 Win64" -DBOOST_ROOT="{Folder where boost is}" -DCMAKE_INSTALL_PREFIX=../install cmake --build . --target install --config Release ``` @@ -96,3 +94,7 @@ $ ./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](blob/develop/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