From a37a5b188ec3c5345eedc0c7c5e7a24b84d528bd Mon Sep 17 00:00:00 2001
From: gcontini <1121667+gcontini@users.noreply.github.com>
Date: 周日, 10 5月 2020 15:30:34 +0800
Subject: [PATCH] improve docs
---
doc/index.rst | 26 ++++++++++++++++++--------
1 files changed, 18 insertions(+), 8 deletions(-)
diff --git a/doc/index.rst b/doc/index.rst
index 63b3e13..b7674c7 100644
--- a/doc/index.rst
+++ b/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.
+* ``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
@@ -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
@@ -78,12 +82,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
@@ -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
********************
--
Gitblit v1.9.1