Gabriele Contini
2020-03-28 467bd47590e337e8c32f7359e58cf59020a96bcd
doc/index.rst
@@ -24,7 +24,7 @@
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"
software closed |:smirk:| . Among the other features the most notable one is: if it runs on a "real hardware"
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.
@@ -39,11 +39,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.
* ``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
@@ -60,8 +61,11 @@
* tools            : Cmake(>3.6), git, make/ninja(linux)
* libraries        : If target is Linux Openssl is required. Windows depends only on system libraries. Boost is necessary to build license generator and to run the tests but it's NOT a dependency of the final `licensecc` library. 
For a complete list of dependencies and supported environments see the :ref:`development/Dependencies:Dependencies` section.
Clone the project. It has submodules, don't forget the `--recursive` option.
For a complete list of dependencies and supported environments see the :ref:`dependencies <development/Dependencies:Dependencies>` section.
Clone the project.
.. NOTE::
  It has submodules, don't forget the `--recursive` option.
.. code-block:: console
@@ -112,10 +116,16 @@
How to use
**************
The `examples`_ repository shows various ways to integrate `licensecc` into your project.
The `examples`_ repository shows various ways to integrate ``licensecc`` into your project.
.. _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
********************