From 510d41ff7d12c8a8ba230d3b3f732b19a20f15e3 Mon Sep 17 00:00:00 2001
From: gcontini <1121667+gcontini@users.noreply.github.com>
Date: 周六, 31 10月 2020 10:28:34 +0800
Subject: [PATCH] doc & miscellaneous changes
---
doc/index.rst | 20 +++++++++++++++-----
1 files changed, 15 insertions(+), 5 deletions(-)
diff --git a/doc/index.rst b/doc/index.rst
index 69b5e14..2eeec3e 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -30,6 +30,9 @@
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.
+
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 +42,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. 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 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 +85,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 +123,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
********************
--
Gitblit v1.9.1