gcontini
2020-11-22 0fd661591e85bbf730bb274a56961432bceb7071
doc/index.rst
@@ -1,7 +1,7 @@
#######################################
C++ software protection with Licensecc
#######################################
Copy protect, restrict the usage of your C++ software with a license file using this library.
Copy protect, restrict the usage of your C++ software with a license file.
|c11|_ |License|_ |unstable|_ |BuildStatus|_ |CodacyBadge|_ |codecov|_ |forum|_ 
@@ -11,8 +11,10 @@
.. _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
.. |BuildStatus| image:: https://travis-ci.org/open-license-manager/open-license-manager.svg?branch=develop
.. _BuildStatus: https://travis-ci.org/open-license-manager/open-license-manager
.. |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/licensecc/workflows/Github_CI/badge.svg
.. _GithubCI: https://github.com/open-license-manager/licensecc/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
@@ -30,6 +32,14 @@
A comprehensive :ref:`list of features <analysis/features:Features>`, and their status is available in the project wiki. 
If you're experiencing problems, or you just need informations you can't find here in the documentation,
please contact us on the `user forum <https://groups.google.com/forum/#!forum/licensecc>`_ (hosted on Google), we'll be happy to help.
Notice
****************
We're in the process of renaming the repository from `open-license-manager` to `licensecc`.
Please update your project references and github remotes. Some link on the website may be broken.
License (BSD)
**************
The project is donated to the community. It comes with a very large freedom of use for everyone, and it will always be. 
@@ -39,11 +49,12 @@
Project Structure
*******************
The software is made by 3 main sub-components:
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.
* ``lccinspector`` : a license debugger to be sent to the final customer to diagnose licensing problems or for calculating the pc hash before issuing the license.
* ``licensecc``    : the C++ library with a C api (the part you have to integrate in your software) with minimal (or no) external dependencies.
* ``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>`_ ).
.. _lcc-license-generator: https://github.com/open-license-manager/lcc-license-generator
@@ -68,8 +79,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
@@ -81,12 +92,12 @@
  make
  make install
Build on Windows (with MSVC 2015)
Build on Windows (with MSVC 2017)
==================================
.. code-block:: console
  cmake .. -G "Visual Studio 14 2015 Win64" -DBOOST_ROOT="{Folder where boost is}" -DCMAKE_INSTALL_PREFIX=../install
  cmake .. -G "Visual Studio 16 2017 Win64" -DBOOST_ROOT="{Folder where boost is}" -DCMAKE_INSTALL_PREFIX=../install
  cmake --build . --target install --config Release
Cross compile with MINGW on Linux
@@ -119,6 +130,12 @@
.. _examples: https://github.com/open-license-manager/examples 
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.
How to contribute
********************
@@ -130,8 +147,8 @@
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
.. _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`