From 55a8483884c70b03c86a6508469f708e48211638 Mon Sep 17 00:00:00 2001
From: gcontini <1121667+gcontini@users.noreply.github.com>
Date: 周六, 28 11月 2020 09:38:30 +0800
Subject: [PATCH] improve documentation add project/feature documentation
---
doc/index.rst | 46 +++++++++++++++++++++++-----------------------
1 files changed, 23 insertions(+), 23 deletions(-)
diff --git a/doc/index.rst b/doc/index.rst
index f5fe6dd..5d89e3e 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -1,9 +1,9 @@
-#######################################
-C++ software protection with Licensecc
-#######################################
-Copy protect, restrict the usage of your C++ software with a license file.
+###########################################
+Licensecc: a C++ software license manager
+###########################################
+Copy protect, limit the usage of your C++ software with a license.
-|c11|_ |License|_ |unstable|_ |BuildStatus|_ |CodacyBadge|_ |codecov|_ |forum|_
+|c11|_ |License|_ |unstable|_ |TravisBuild|_ |GithubCI|_ |CodacyBadge|_ |codecov|_ |forum|_
.. |c11| image:: https://img.shields.io/badge/c%2B%2B-11-blue.svg
.. _c11: https://en.wikipedia.org/wiki/C%2B%2B#Standardization
@@ -11,34 +11,30 @@
.. _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
-.. |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
+.. |TravisBuild| image:: https://travis-ci.org/open-license-manager/licensecc.svg?branch=develop
+.. _TravisBuild: https://travis-ci.org/open-license-manager/licensecc
.. |GithubCI| image:: https://github.com/open-license-manager/licensecc/workflows/Github_CI/badge.svg
.. _GithubCI: https://github.com/open-license-manager/licensecc/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&utm_medium=referral&utm_content=open-license-manager/open-license-manager&utm_campaign=Badge_Grade
-.. |codecov| image:: https://codecov.io/gh/open-license-manager/open-license-manager/branch/develop/graph/badge.svg
-.. _codecov: https://codecov.io/gh/open-license-manager/open-license-manager
-.. |issues| image:: https://img.shields.io/github/issues/open-license-manager/open-license-manager
-.. _issues: http://github.com/open-license-manager/open-license-manager/issues
+.. |CodacyBadge| image:: https://app.codacy.com/project/badge/Grade/81a1f6bc15014618934fc5fab4d3c206
+.. _CodacyBadge: https://www.codacy.com/gh/open-license-manager/licensecc/dashboard?utm_source=github.com&utm_medium=referral&utm_content=open-license-manager/licensecc&utm_campaign=Badge_Grade
+.. |codecov| image:: https://codecov.io/gh/open-license-manager/licensecc/branch/develop/graph/badge.svg
+.. _codecov: https://codecov.io/gh/open-license-manager/licensecc
+.. |issues| image:: https://img.shields.io/github/issues/licensecc/open-license-manager
+.. _issues: http://github.com/open-license-manager/licensecc/issues
.. |forum| image:: https://img.shields.io/badge/forum-licensecc-blue.svg?style=flat
.. _forum: https://groups.google.com/d/forum/licensecc
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"
+machines, or prevent the usage in virtualized environments. `Licensecc` 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" (not a container/vm)
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.
+the software has been copied to another place.
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.
-
-Notice
-****************
-We're in the process of renaming the repository from `open-license-manager` to `licensecc`.
-Please update your project references and github remotes. Some link on the website may be broken.
License (BSD)
**************
@@ -51,7 +47,7 @@
*******************
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.
+* ``licensecc`` : the C++ library with a C api (the part you have to integrate in your software) with minimal external dependencies. (github project `licensecc <https://github.com/open-license-manager/licensecc>`_ )
* ``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>`_ ).
@@ -196,4 +192,8 @@
:caption: Miscellaneous:
other/*
-
+
+.. meta::
+ :description: open source license manager, copy protection library in C++.
+ :keywords: license manager, c++, open source, copy protection, hardware identifcation
+ :title: a
--
Gitblit v1.9.1