From f4e683fc6bd6ac76f9979f49d737588b6ddf16b0 Mon Sep 17 00:00:00 2001
From: gcontini <1121667+gcontini@users.noreply.github.com>
Date: 周六, 14 11月 2020 22:13:13 +0800
Subject: [PATCH] windows smbios

---
 doc/index.rst |   35 +++++++++++++++++++++++++----------
 1 files changed, 25 insertions(+), 10 deletions(-)

diff --git a/doc/index.rst b/doc/index.rst
index 63b3e13..e7b1c53 100644
--- a/doc/index.rst
+++ b/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/open-license-manager/workflows/Github_CI/badge.svg
+.. _GithubCI: https://github.com/open-license-manager/open-license-manager/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&amp;utm_medium=referral&amp;utm_content=open-license-manager/open-license-manager&amp;utm_campaign=Badge_Grade
 .. |codecov| image:: https://codecov.io/gh/open-license-manager/open-license-manager/branch/develop/graph/badge.svg
@@ -24,11 +26,14 @@
 
 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.
 
 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)
 **************
@@ -39,11 +44,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 +66,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 +87,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
@@ -116,6 +125,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