From d55193ac23370e076124553339d9f49624e53934 Mon Sep 17 00:00:00 2001
From: Gabriele Contini <contini.mailing@gmail.com>
Date: 周日, 10 5月 2020 15:30:34 +0800
Subject: [PATCH] improve docs
---
doc/index.rst | 17 ++++++++++++-----
1 files changed, 12 insertions(+), 5 deletions(-)
diff --git a/doc/index.rst b/doc/index.rst
index 69b5e14..b7674c7 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -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
@@ -81,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
@@ -115,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