From de168518aab3ac8a0222e04bc9b19c9562e00f34 Mon Sep 17 00:00:00 2001 From: gcontini <1121667+gcontini@users.noreply.github.com> Date: 周日, 08 11月 2020 09:15:26 +0800 Subject: [PATCH] project clarification --- /dev/null | 13 ------------- doc/other/glossary.rst | 22 ++++++++++++++++++++++ doc/index.rst | 2 +- 3 files changed, 23 insertions(+), 14 deletions(-) diff --git a/doc/index.rst b/doc/index.rst index 161e54d..38aba77 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|_ diff --git a/doc/other/glossary.md b/doc/other/glossary.md deleted file mode 100644 index 9234d31..0000000 --- a/doc/other/glossary.md +++ /dev/null @@ -1,13 +0,0 @@ -# Glossary - -Some `common` word that recur into the documentation have a specific meaning. Below an explanation of the terms and concepts used. - -## Project -A project corresponds to one application where the licensing system need to be integrated. -Each project has its own private key and its own folder where `licensecc` is compiled. -Currently we support only one project per (build) machine. This is especially true in Windows, where the private key has the same name for all the projects. - -## Features -Features let licensed application to selectively enable or disable functions in the application, features are part of the original license, they do not have hardware identifications, they only have validity date. - - diff --git a/doc/other/glossary.rst b/doc/other/glossary.rst new file mode 100644 index 0000000..6f9cfac --- /dev/null +++ b/doc/other/glossary.rst @@ -0,0 +1,22 @@ +############################# +Glossary +############################# + +Some `common` word that recur into the documentation have a specific meaning. Below an explanation of the terms and concepts used. + +.. glossary:: + + Project + A project in licensecc terminology usually corresponds to one of your applications where the licensing system need to be integrated. + For instance you want to release the executable ``Foo.exe`` you may want to create a project ``Foo`` in licensecc. + A ``licensecc-project`` is the set of customizations needed to compile licensecc-library for your own application: + (1) a private key used to issue licenses, + (2) a public key (included at compile time in licensecc library) used to verify licenses, + (3) a set of build parameters and customizations specific to your application. + One source code branch of licensecc may "serve" multiple projects: every time you build you may specify for which project + you need to compile and the build system will select the right include files (eg: `public_key.h`). + + Features + Features let licensed application to selectively enable or disable functions in the application. + + -- Gitblit v1.9.1