From dfe2d04b3035920accddba005d985d7a1d1d43b5 Mon Sep 17 00:00:00 2001 From: gcontini <1121667+gcontini@users.noreply.github.com> Date: 周六, 22 5月 2021 11:23:20 +0800 Subject: [PATCH] update versions 2.0-> 2.1 --- doc/index.rst | 62 +++++++++++++++++------------- 1 files changed, 35 insertions(+), 27 deletions(-) diff --git a/doc/index.rst b/doc/index.rst index e7b1c53..1e6c7ba 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,9 +1,9 @@ -####################################### -C++ software protection with Licensecc -####################################### -Copy protect, restrict the usage of your C++ software with a license file. +############## +Licensecc +############## +*Copy protection, licensing library and license generator for Windows and Linux.* -|c11|_ |License|_ |unstable|_ |BuildStatus|_ |CodacyBadge|_ |codecov|_ |forum|_ +|c11|_ |License|_ |unstable|_ |TravisBuild|_ |GithubCI|_ |CodacyBadge|_ |codecov|_ |forum|_ .. |c11| image:: https://img.shields.io/badge/c%2B%2B-11-blue.svg .. _c11: https://en.wikipedia.org/wiki/C%2B%2B#Standardization @@ -11,24 +11,26 @@ .. _unstable: http://github.com/badges/stability-badges .. |License| image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg .. _License: ttps://opensource.org/licenses/BSD-3-Clause -.. |TravisBuild| image:: https://travis-ci.org/open-license-manager/open-license-manager.svg?branch=develop -.. _TravisBuild: https://travis-ci.org/open-license-manager/open-license-manager -.. |GithubCI| image:: https://github.com/open-license-manager/open-license-manager/workflows/Github_CI/badge.svg -.. _GithubCI: https://github.com/open-license-manager/open-license-manager/actions -.. |CodacyBadge| image:: https://api.codacy.com/project/badge/Grade/62d6e1bb22d648bd85b6f3bc344a545a -.. _CodacyBadge: 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 -.. |codecov| image:: https://codecov.io/gh/open-license-manager/open-license-manager/branch/develop/graph/badge.svg -.. _codecov: https://codecov.io/gh/open-license-manager/open-license-manager -.. |issues| image:: https://img.shields.io/github/issues/open-license-manager/open-license-manager -.. _issues: http://github.com/open-license-manager/open-license-manager/issues +.. |TravisBuild| image:: https://travis-ci.org/open-license-manager/licensecc.svg?branch=develop +.. _TravisBuild: https://travis-ci.org/open-license-manager/licensecc +.. |GithubCI| image:: https://github.com/open-license-manager/licensecc/workflows/Github_CI/badge.svg +.. _GithubCI: https://github.com/open-license-manager/licensecc/actions +.. |CodacyBadge| image:: https://app.codacy.com/project/badge/Grade/81a1f6bc15014618934fc5fab4d3c206 +.. _CodacyBadge: https://www.codacy.com/gh/open-license-manager/licensecc/dashboard?utm_source=github.com&utm_medium=referral&utm_content=open-license-manager/licensecc&utm_campaign=Badge_Grade +.. |codecov| image:: https://codecov.io/gh/open-license-manager/licensecc/branch/develop/graph/badge.svg?token=vdrBBzX6Rl +.. _codecov: https://codecov.io/gh/open-license-manager/licensecc +.. |issues| image:: https://img.shields.io/github/issues/open-license-manager/licensecc +.. _issues: http://github.com/open-license-manager/licensecc/issues .. |forum| image:: https://img.shields.io/badge/forum-licensecc-blue.svg?style=flat -.. _forum: https://groups.google.com/d/forum/licensecc +.. _forum: https://github.com/open-license-manager/licensecc/discussions 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 source license management system that helps to keep your -software closed |:smirk:| . Among the other features the most notable one is: if it runs on a "real hardware" +machines, or prevent the usage in virtualized environments. `Licensecc` is an open source license management system +that helps to keep your software closed |:smirk:| . + +Among the other features the most notable one is: if it runs on a "real hardware" (not a container/vm) it can generate a signature of that hardware and report if the signature doesn't match, because for instance -the software has been copied to another pc. +the software has been copied to another place. A comprehensive :ref:`list of features <analysis/features:Features>`, and their status is available in the project wiki. @@ -46,7 +48,7 @@ ******************* The software is made by 4 main sub-components: -* ``licensecc`` : the C++ library with a C api (the part you have to integrate in your software) with minimal (or no) external dependencies. This is the project you're currently looking at. +* ``licensecc`` : the C++ library with a C api (the part you have to integrate in your software) with minimal external dependencies. (github project `licensecc <https://github.com/open-license-manager/licensecc>`_ ) * ``lccinspector`` : a license debugger to be sent to the final customer to diagnose licensing problems or for calculating the hardware id before issuing the license. * ``lccgen`` : a license generator (github project `lcc-license-generator`_ ) to initialize the library and generate the licenses. * ``examples`` : usage samples (github project `examples <https://github.com/open-license-manager/examples>`_ ). @@ -74,8 +76,8 @@ .. code-block:: console - git clone --recursive https://github.com/open-license-manager/open-license-manager.git - cd open-license-manager/ + git clone --recursive https://github.com/open-license-manager/licensecc.git + cd licensecc/ cd build Build on Linux @@ -128,8 +130,8 @@ Branches and status ********************* -* On branch ``master`` there is the 'legacy' 1.0.0 version. This version is working but doesn't correspond to the current documentation, and we don't plan to actively fix it. There are well-known bugs and limitations. We still accept community contributions on this branch. Feel free to propose your pull request. -* On branch ``develop`` there is the upcoming 2.0.0 version that corresponds to the documentation. This version is under development and has not been extensively used/tested. However we encourage users to download and use this one. +* On branch ``master`` there is the 'stable' 2.0.0 version. +* On branch ``develop`` there is the upcoming 2.1.0 version that corresponds to this documentation. This version is under development and has not been extensively used/tested. However we encourage users to download and use this one. How to contribute ******************** @@ -141,9 +143,9 @@ We use `GitFlow`_ (or at least a subset of it). Remember to install the gitflow git plugin and use ``develop`` as default branch for your pull requests. -.. _forums: https://groups.google.com/forum/#!forum/licensecc -.. _issue system: https://github.com/open-license-manager/open-license-manager/issues -.. _contribution guidelines: https://github.com/open-license-manager/open-license-manager/blob/develop/CONTRIBUTING.md +.. _forums: https://github.com/open-license-manager/licensecc/discussions +.. _issue system: https://github.com/open-license-manager/licensecc/issues +.. _contribution guidelines: https://github.com/open-license-manager/licensecc/blob/develop/CONTRIBUTING.md .. _GitFlow: https://datasift.github.io/gitflow/IntroducingGitFlow.html * :ref:`genindex` @@ -191,4 +193,10 @@ :caption: Miscellaneous: other/* + +.. meta:: + :description: open source license manager, copy protection library in C++. + :keywords: c++, open source, licensing software, copy protection, license manager, hardware identifcation +.. title:: + C++ copy protection library -- Gitblit v1.9.1