From ecd2f38f3d9c8b28aaa4c47bc09789f11dcaa7f7 Mon Sep 17 00:00:00 2001
From: gcontini <1121667+gcontini@users.noreply.github.com>
Date: 周日, 29 11月 2020 11:19:33 +0800
Subject: [PATCH] fix documentation warnings and broken links
---
CONTRIBUTING.md | 13 ++++++-------
README.md | 6 +++---
doc/index.rst | 15 +++++++++------
3 files changed, 18 insertions(+), 16 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9290f94..a1ab216 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,5 +1,4 @@
-Contributing to Licensecc
-==========
+# Contributing to Licensecc
## Interacting with the team
@@ -55,9 +54,9 @@
Contributions to `licensecc` will be subject to the following rules:
- - small patches eg. documentation changes, small bug fixes can be submitted directly on github, use the description of the patch to shortly explain the content of the patch.
- - if the patch is not completely trivial please open an issue first and provide a description of what you want to achieve.
- - larger contributions should be discussed first on the [project forum](https://groups.google.com/forum/#!forum/licensecc).
+- small patches eg. documentation changes, small bug fixes can be submitted directly on github, use the description of the patch to shortly explain the content of the patch.
+- if the patch is not completely trivial please open an issue first and provide a description of what you want to achieve.
+- larger contributions should be discussed first on the [project forum](https://groups.google.com/forum/#!forum/licensecc).
If you want to contribute we are happy to integrate your code. You can start by looking through the [`good first issue`](https://github.com/open-license-manager/licensecc/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and [`help-wanted`](https://github.com/open-license-manager/licensecc/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) issues.
@@ -80,5 +79,5 @@
##### Don't
- Don't reformat the code following your personal likes, it introduce a lot of "noise" and makes very hard to merge. Use the clang-format style provided at the base of the project.
- Very large pull requests with few comments, no corresponding issue explaining what's it about will probably be rejected.
- - We understand that the project is still in beta stage, however we would like to discuss it with you before we take project changing decision. You can reach us on the [project forum](https://groups.google.com/forum/#!forum/licensecc).
-
+- We understand that the project is still in beta stage, however we would like to discuss it with you before we take project changing decision. You can reach us on the [project forum](https://groups.google.com/forum/#!forum/licensecc).
+
diff --git a/README.md b/README.md
index 081b830..a8dfc5e 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-# Licensecc
+# Licensecc: protect your C++ software from unauthorized copies.
-Copy protection, licensing software in C++ for Windows and Linux (with a simple C api for use in C projects).
+*Copy protection, licensing library and license generator for Windows and Linux.*
[](https://en.wikipedia.org/wiki/C%2B%2B#Standardization)
[](http://github.com/badges/stability-badges)
@@ -8,7 +8,7 @@
[](https://travis-ci.org/open-license-manager/licensecc)
[](https://github.com/open-license-manager/licensecc/actions)
[](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)
-[](https://codecov.io/gh/open-license-manager/open-license-manager)
+[](https://codecov.io/gh/open-license-manager/licensecc)
[](http://github.com/open-license-manager/licensecc/issues)
[](https://groups.google.com/d/forum/licensecc)
diff --git a/doc/index.rst b/doc/index.rst
index 5d89e3e..29a66ea 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -1,7 +1,7 @@
###########################################
-Licensecc: a C++ software license manager
+Licensecc: a C++ license manager
###########################################
-Copy protect, limit the usage of your C++ software with a license.
+*Copy protection, licensing library and license generator for Windows and Linux.*
|c11|_ |License|_ |unstable|_ |TravisBuild|_ |GithubCI|_ |CodacyBadge|_ |codecov|_ |forum|_
@@ -17,9 +17,9 @@
.. _GithubCI: https://github.com/open-license-manager/licensecc/actions
.. |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| image:: https://codecov.io/gh/open-license-manager/licensecc/branch/develop/graph/badge.svg?token=vdrBBzX6Rl
.. _codecov: https://codecov.io/gh/open-license-manager/licensecc
-.. |issues| image:: https://img.shields.io/github/issues/licensecc/open-license-manager
+.. |issues| image:: https://img.shields.io/github/issues/open-license-manager/licensecc
.. _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
@@ -27,6 +27,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. `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 place.
@@ -195,5 +196,7 @@
.. meta::
:description: open source license manager, copy protection library in C++.
- :keywords: license manager, c++, open source, copy protection, hardware identifcation
- :title: a
+ :keywords: c++, licensing software, license manager, open source, copy protection, hardware identifcation
+
+.. title::
+ Copy protection in C++
--
Gitblit v1.9.1