From 0fd661591e85bbf730bb274a56961432bceb7071 Mon Sep 17 00:00:00 2001 From: gcontini <1121667+gcontini@users.noreply.github.com> Date: Sun, 22 Nov 2020 09:26:29 +0800 Subject: [PATCH] repo rename: open-license-manager -> licensecc --- CONTRIBUTING.md | 53 +++++++++---------- LICENSE | 2 +- README.md | 33 ++++++------ doc/_templates/breadcrumbs.html | 12 ++--- .../Development-And-Usage-Workflow.md | 6 +-- doc/analysis/features.rst | 4 +- doc/conf.py | 4 +- doc/development/Build-the-library-windows.rst | 6 +-- doc/development/Build-the-library.md | 11 ++-- doc/development/Dependencies.md | 6 +-- doc/index.rst | 19 ++++--- doc/other/CREDITS.md | 2 +- doc/other/QA.md | 18 ++++--- doc/other/glossary.rst | 2 +- doc/usage/License-retrieval.md | 2 +- doc/usage/integration.rst | 2 +- doc/usage/issue-licenses.md | 5 +- 17 files changed, 97 insertions(+), 90 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2f59c209..9290f94c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,68 +1,65 @@ -Contributing to Open License Manager +Contributing to Licensecc ========== -The following is a set of guidelines for contributing to Open License Manager and its sub-projects. +## Interacting with the team -## How to contribute +If you're experiencing issues with the project, due to lack of documentation +or you want to ask a question you can contact us on +[project forum](https://groups.google.com/forum/#!forum/licensecc). +The forum is the preferred way of contact because your question are useful +to other people. -### Interacting with the team - -If you're experiencing issues with the project, due to lack of documentation or you basically just want to ask a question you can contact us on [project forum](https://groups.google.com/forum/#!forum/licensecc). If you're compiling `licensecc` following the guide and you meet an issue you'd better open a bug. Please try to be very specific about your problem. You can use the guidelines in ["How to Submit A (Good) Bug Report"](#how-to-submit-a-good-bug-report) to structure your question. +If you're compiling `licensecc` following the guide and you meet a software issue +(eg. doesn't compile, it crashes) you can submit an issue. Please try to be very specific about your problem. +You can use the guidelines in ["How to Submit A (Good) Bug Report"](#how-to-submit-a-good-bug-report) to structure your question. ### Reporting Bugs -Before creating bug reports, please [check the repository](https://github.com/open-license-manager/open-license-manager/issues) to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. When you are creating a bug report, please [include as many details as possible](#how-to-submit-a-good-bug-report). +Before creating bug reports, please [check the repository](https://github.com/open-license-manager/licensecc/issues) to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. When you are creating a bug report, please [include as many details as possible](#how-to-submit-a-good-bug-report). #### How to submit a good Bug Report Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Explain the problem and include additional details to help maintainers reproduce the problem: - **Use a clear and descriptive title** for the issue to identify the problem. -- **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how are you using Open License Manager. +- **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how are you using Licensecc. - **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or licenses, which can cause the bug. If you're providing code snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines). - **Describe the current behavior and the expected one*** Describe the current result, and the expected behavior. - **Provide a unit test to demonstrate the bug**. The best way to report a bug, and to have it fixed **forever** is to design a test to demonstrate it. -- **If you're reporting that Open License Manager crashed**, include a crash dump and the associated message. +- **If you're reporting that Licensecc crashed**, include a crash dump and the associated message. - **Label the issue as bug.** Provide more context by answering these questions: - **Can you reproduce the problem using the example application?** - **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens. -- If the problem is related integrating Open License Manager with your application, **produce a minimal example to demonstrate it** Does the problem happen only with some license type? Does the problem only happen in Linux/Docker/Windows? +- If the problem is related integrating Licensecc with your application, **produce a minimal example to demonstrate it** Does the problem happen only with some license type? Does the problem only happen in Linux/Docker/Windows? Include details about your configuration and environment: -- **Update Open License Manager to the latest version** If possible try to pull the latest changes from `develop` branch. +- **Update Licensecc to the latest version** If possible try to pull the latest changes from `develop` branch. - **What's the name and version of the OS you're using**? - **What's the name and version of the compiler you're using**? Are you cross compiling? If you're cross compiling specify the host and the target operating system. - **What's are the `cmake` command line you used to generate your build scripts**? -- **Are you running Open License Manager in a virtual machine/docker?** If so, which VM software are you using and which operating systems and versions are used for the guest? +- **Are you running Licensecc in a virtual machine/docker?** If so, which VM software are you using and which operating systems and versions are used for the guest? ### Suggesting Enhancements or new features -This section guides you through submitting an enhancement suggestion for Open License Manager, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:. - If you have an idea about a new feature or a question about an environment support, the simplest way you can reach the team is through the [project forum](https://groups.google.com/forum/#!forum/licensecc). -Otherwise you can open an enhancement suggestion in github. Before you do so check [existing enhancement request](https://github.com/open-license-manager/open-license-manager/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3Aenhancement) to see if the enhancement has already been suggested. When you are creating an enhancement suggestion, please [include as many details as possible](#how-to-submit-a-good-enhancement-suggestion). - -Please also check for the [current and planned features](https://github.com/open-license-manager/open-license-manager/wiki/features) in the wiki to see where the project is heading to. +Otherwise you can open an enhancement suggestion in github. Before you do so check [existing enhancement request](https://github.com/open-license-manager/licensecc/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3Aenhancement) to see if the enhancement has already been suggested. -#### How to submit a (good) enhancement suggestion +Please also check for the [current and planned features](https://github.com/open-license-manager/licensecc/wiki/features) in the wiki to see where the project is heading to. -Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). +### Code contributions -- **Use a clear and descriptive title** for the issue to identify the suggestion. -- **Provide a detailed description of the suggested enhancement** in as many details as possible. -- **Explain why this enhancement would be useful** to most Open License Manager users and isn't something that can or should be implemented. -- **List some other software protection where this feature exists.** -- **Specify the name and version of the OS you're proposing the enhancement for.** If applicable include all the environment informations: is this for running the application in a VM? in a Docker? -- **Label the issue as enhancement.** +Contributions to `licensecc` will be subject to the following rules: -### Your first code contribution + - 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). -Unsure where to begin contributing to Open License Manager? You can start by looking through the [`good first issue`](https://github.com/open-license-manager/open-license-manager/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/open-license-manager/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) issues. +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. You can have a look to the project upcoming milestones to see what's going to be implemented soon and what is the project direction. If you decide to contribute on an issue scheduled in the current milestone, comment on the issue first. If the issue is marked as "assigned" there may be already some work done for it. Commenting on the issue will ensure we don't duplicate our work. Also have a look to the branches: there may be a feature branch corresponding to the issue with some work already done. @@ -70,7 +67,7 @@ If you have already forked the repository to implement a specific feature, and y We apply a subset of [GitFlow](https://nvie.com/posts/a-successful-git-branching-model) development workflow. Be sure to work against `develop` branch, since `master` is reserved for stable releases, and may be outdated. -#### General coding rules +#### General coding rules (for larger contributions) Supposing you already know how to contribute to an open source project on GitHub (if you have doubts you can check this short [guide](https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project) ), you're working on an existing issue the code is already committed on your fork. diff --git a/LICENSE b/LICENSE index b57fa6f6..694845ec 100644 --- a/LICENSE +++ b/LICENSE @@ -12,7 +12,7 @@ modification, are permitted provided that the following conditions are met: this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -* Neither the name of "open-license-manager" nor the names of its +* Neither the name of "licensecc" nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. diff --git a/README.md b/README.md index 4c7012e1..f17eb2bc 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,41 @@ -# Open License Manager +# Licensecc -A copy protection, licensing software written in C++ for Windows and Linux (with a simple C api for use in C projects). +Copy protection, licensing software in C++ for Windows and Linux (with a simple C api for use in C projects). [![Standard](https://img.shields.io/badge/c%2B%2B-11-blue.svg)](https://en.wikipedia.org/wiki/C%2B%2B#Standardization) [![unstable](http://badges.github.io/stability-badges/dist/unstable.svg)](http://github.com/badges/stability-badges) [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) [![travis](https://travis-ci.org/open-license-manager/open-license-manager.svg?branch=develop)](https://travis-ci.org/open-license-manager/open-license-manager) -[![Github_CI](https://github.com/open-license-manager/open-license-manager/workflows/Github_CI/badge.svg)](https://github.com/open-license-manager/open-license-manager/actions) +[![Github_CI](https://github.com/open-license-manager/licensecc/workflows/Github_CI/badge.svg)](https://github.com/open-license-manager/licensecc/actions) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/62d6e1bb22d648bd85b6f3bc344a545a)](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](https://codecov.io/gh/open-license-manager/open-license-manager/branch/develop/graph/badge.svg)](https://codecov.io/gh/open-license-manager/open-license-manager) -[![Github Issues](https://img.shields.io/github/issues/open-license-manager/open-license-manager)](http://github.com/open-license-manager/open-license-manager/issues) +[![Github Issues](https://img.shields.io/github/issues/open-license-manager/licensecc)](http://github.com/open-license-manager/licensecc/issues) [![forum : licensecc](https://img.shields.io/badge/forum-licensecc-blue.svg)](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 License Manager that helps to keep your +machines, or prevent the usage in virtualized environments. It is an open source license manager that helps to keep your software closed :smirk: . Among other features if it runs on a "real hardware" it can generate a signature of that hardware and report if the signature doesn't match. -A comprehensive [list of features](http://open-license-manager.github.io/open-license-manager/analysis/features.html), and their status is available in the project site. +A comprehensive [list of features](http://open-license-manager.github.io/licensecc/analysis/features.html), and their status is available in the project site. -If you're experiencing problems, or you just need informations you can't find in the [documentation](http://open-license-manager.github.io/open-license-manager) please contact us on the [user forum](https://groups.google.com/forum/#!forum/licensecc) (hosted on Google), we'll be happy to help. +If you're experiencing problems, or you just need informations you can't find in the [documentation](http://open-license-manager.github.io/licensecc) please contact us on the [user forum](https://groups.google.com/forum/#!forum/licensecc) (hosted on Google), we'll be happy to help. -Remember to show your appreciation giving us a star here on GitHub. +Remember to show your appreciation giving us a star here on GitHub. ## License The project is donated to the community. It comes with a very large freedom of use for everyone, and it will always be. It uses a [BSD 3 clauses](https://opensource.org/licenses/BSD-3-Clause) licensing schema, that allows free modification and inclusion in commercial software. ## Project Structure -The software is made by 3 main sub-components: +The software is made by 4 main sub-components: - a C++ library with a nice C api, `licensecc` with minimal (or no) external dependencies (the part you have to integrate in your software) that is the project you're currently in. - a license debugger `lcc-inspector` to be sent to the final customer when there are licensing problems or for calculating the pc hash before issuing the license. - a license generator (github project [lcc-license-generator](https://github.com/open-license-manager/lcc-license-generator)) `lccgen` for customizing the library and generate the licenses. +- examples projecs ## How to build -Below an overview of the basic build procedure, you can find detailed instructions for [Linux](http://open-license-manager.github.io/open-license-manager/development/Build-the-library.html) -or [Windows](http://open-license-manager.github.io/open-license-manager/development/Build-the-library-windows.html) in the project web site. +Below an overview of the basic build procedure, you can find detailed instructions for [Linux](http://open-license-manager.github.io/licensecc/development/Build-the-library.html) +or [Windows](http://open-license-manager.github.io/licensecc/development/Build-the-library-windows.html) in the project web site. ### Prerequisites - Operating system: Linux(Ubuntu, CentOS), Windows @@ -42,13 +43,13 @@ or [Windows](http://open-license-manager.github.io/open-license-manager/developm - tools : cmake(>3.6), git, make/ninja(linux) - libs : 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 project website](http://open-license-manager.github.io/open-license-manager/development/Dependencies.html) +For a complete list of dependencies and supported environments see [the project website](http://open-license-manager.github.io/licensecc/development/Dependencies.html) Clone the project. It has submodules, don't forget the `--recursive` option. ```console -git clone --recursive https://github.com/open-license-manager/open-license-manager.git -cd open-license-manager/build +git clone --recursive https://github.com/open-license-manager/licensecc.git +cd licensecc/build ``` ### build on Linux @@ -90,11 +91,11 @@ ctest -C Release ## How to use -The [examples](https://github.com/open-license-manager/examples) repository that shows various ways to integrate `open-licence-manager` into your project. +The [examples](https://github.com/open-license-manager/examples) repository that shows various ways to integrate `licensecc` into your project. ## How to contribute -The easiest way you can solve your problems or ask help is through the [forum](https://groups.google.com/forum/#!forum/licensecc) (hosted on Google), otherwise if you think there is a problem you can open an issue in the [issue system](https://github.com/open-license-manager/open-license-manager/issues). +The easiest way you can solve your problems or ask help is through the [forum](https://groups.google.com/forum/#!forum/licensecc) (hosted on Google), otherwise if you think there is a problem you can open an issue in the [issue system](https://github.com/open-license-manager/licensecc/issues). Have a look to the [contribution guidelines](CONTRIBUTING.md) before reporting. We use [GitFlow](https://datasift.github.io/gitflow/IntroducingGitFlow.html) (or at least a subset of it). Remember to install the gitflow git plugin and use `develop` as default branch for your pull requests. diff --git a/doc/_templates/breadcrumbs.html b/doc/_templates/breadcrumbs.html index 059aeaf5..64d344df 100644 --- a/doc/_templates/breadcrumbs.html +++ b/doc/_templates/breadcrumbs.html @@ -3,19 +3,19 @@ {% block breadcrumbs_aside %}
  • Star + aria-label="Star open-license-manager/licensecc on GitHub">Star Fork + aria-label="Fork open-license-manager/licensecc on GitHub">Fork Issue + aria-label="Issue open-license-manager/licensecc on GitHub">Issue
    • {% endblock %} diff --git a/doc/analysis/Development-And-Usage-Workflow.md b/doc/analysis/Development-And-Usage-Workflow.md index 763aa176..8e12ff58 100644 --- a/doc/analysis/Development-And-Usage-Workflow.md +++ b/doc/analysis/Development-And-Usage-Workflow.md @@ -1,6 +1,6 @@ # Development and usage workflow -Below a description of the planned development and usage process. Comments and progress are reported on [issue #42](https://github.com/open-license-manager/open-license-manager/issues/42) +Below a description of the planned development and usage process. Comments and progress are reported on [issue #42](https://github.com/open-license-manager/licensecc/issues/42) ![dev-build-process](https://user-images.githubusercontent.com/1121667/64474031-e5afff80-d1a0-11e9-9819-f3b7e4e2126d.png) @@ -10,7 +10,7 @@ Travis CI builds the release for the supported environments and deploys it to Gi ### Binary release contents Binary release contains: - * open-license-manager executable (`lccgen`). + * license generator executable (`lccgen`). * source code of the unconfigured library. * source code of (part of) the tests. @@ -20,7 +20,7 @@ A special attention is about how carry out functional tests. In this phase the library is configured, compiled (only for the tests sake), linked with a mock executable and tested together with the license generator. ## Initialize library -In this phase the signing keys are generated by open-license-manager executable (`lcc`), and optionally the source code of the library may be modified or obfuscated. +In this phase the signing keys are generated by license generator executable (`lccgen`), and optionally the source code of the library may be modified or obfuscated. ### Test (2) diff --git a/doc/analysis/features.rst b/doc/analysis/features.rst index 9fb1bdfa..04297c9f 100644 --- a/doc/analysis/features.rst +++ b/doc/analysis/features.rst @@ -70,7 +70,7 @@ This can be done in multiple ways: * without a central server, using broadcast or scanning the local network to find peers. * with a central server installed in the client's network. * with a central server on internet. -Status of this implementation is tracked in `issue #4 `_ +Status of this implementation is tracked in `issue #4 `_ .. _Execution Limits: @@ -122,7 +122,7 @@ Cpu Number/Machine memory =============================== Allow to restrict the execution only to a machine with the specified amount of cpu or memory or less. This is useful in virtualized environments, to create a licensed software demo version with limited performaces or with limited scalability. -Status of this implementation is tracked in `issue #3 `_ +Status of this implementation is tracked in `issue #3 `_ Virtualization type ========================== diff --git a/doc/conf.py b/doc/conf.py index 1b14e55c..c2a8d428 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -98,7 +98,7 @@ # documentation. # html_theme_options = { - 'canonical_url': 'http://open-license-manager.github.io/open-license-manager/', + 'canonical_url': 'http://open-license-manager.github.io/licensecc/', 'analytics_id': 'UA-160839650-1', # Provided by Google in your dashboard 'titles_only': False } @@ -185,7 +185,7 @@ ] # Sitemap plugin -html_baseurl = 'http://open-license-manager.github.io/open-license-manager' +html_baseurl = 'http://open-license-manager.github.io/licensecc' #sitemap_url_scheme = "{lang}{version}subdir/{link}" sitemap_url_scheme = "{link}" diff --git a/doc/development/Build-the-library-windows.rst b/doc/development/Build-the-library-windows.rst index c689b09c..1a0ac93c 100644 --- a/doc/development/Build-the-library-windows.rst +++ b/doc/development/Build-the-library-windows.rst @@ -33,7 +33,7 @@ Check out the code using git: .. code-block:: console - git clone --recursive https://github.com/open-license-manager/open-license-manager.git + git clone --recursive https://github.com/open-license-manager/licensecc.git Compile and build (command line) ==================================== @@ -127,8 +127,8 @@ Verify boost is really compiled. Go to the folder where you want to download `li .. code-block:: console - git clone --recursive https://github.com/open-license-manager/open-license-manager.git - cd build && cmake -G "MinGW Makefiles" -DBOOST_ROOT="C:/local/boost_1_68_0/boost-mingw" -DBoost_ARCHITECTURE="-x64" -DCMAKE_CXX_COMPILER_ARCHITECTURE_ID="x64" -DCMAKE_SH="CMAKE_SH-NOTFOUND" .. + git clone --recursive https://github.com/open-license-manager/licensecc.git + cd licensecc/build && cmake -G "MinGW Makefiles" -DBOOST_ROOT="C:/local/boost_1_68_0/boost-mingw" -DBoost_ARCHITECTURE="-x64" -DCMAKE_CXX_COMPILER_ARCHITECTURE_ID="x64" -DCMAKE_SH="CMAKE_SH-NOTFOUND" .. cmake --build . --target install --config Release And then you can test it: diff --git a/doc/development/Build-the-library.md b/doc/development/Build-the-library.md index aeaee581..4e0861ba 100644 --- a/doc/development/Build-the-library.md +++ b/doc/development/Build-the-library.md @@ -1,11 +1,12 @@ # Build - Linux ## Install prerequisites -Below the prerequisites for compiling `open-license-manager`. For developing it we use Eclipse. +Below the prerequisites for compiling `licensecc`. For developing it we use Eclipse. Recent CDT works smoothly with CMake. Remember to install the Ninja package as build system and Cmake Gui for a good eclipse integration. ### Ubuntu -Supported Ubuntu distributions are 20.04 (Focal Fossa), 18.04 (Bionic Beaver) and 16.04 (Xenial). It should be possible to build on any recent Ubuntu (debian like) version. +Supported Ubuntu distributions are 20.04 (Focal Fossa), 18.04 (Bionic Beaver) and 16.04 (Xenial). +It should be possible to build on any recent Debian-derivate distribution. Install prerequisites: @@ -69,7 +70,7 @@ sudo make install ``` ### Other linux -Open License Manager should compile on any recent (2019) linux distribution. Being CentOS 7 the older distribution we keep compatibilty with. +Licensecc should compile on any recent (2020) linux distribution. Being CentOS 7 the older distribution we keep compatibilty with. Minimum prerequisites * gcc => 4.9, cmake => 3.6 @@ -85,13 +86,13 @@ Optional prerequisites: This project has a submodule (the license generator). Remember to add the option `--recursive` to clone it. ```console -git clone --recursive https://github.com/open-license-manager/open-license-manager.git +git clone --recursive https://github.com/open-license-manager/licensecc.git ``` ### Configure: ```console -cd open-license-manager/build +cd licensecc/build cmake .. -DCMAKE_INSTALL_PREFIX=../install ``` diff --git a/doc/development/Dependencies.md b/doc/development/Dependencies.md index 0c22d27d..1eee28b9 100644 --- a/doc/development/Dependencies.md +++ b/doc/development/Dependencies.md @@ -1,12 +1,12 @@ # Dependencies -This page describes the dependencies of open-license-manager and the supported build environments. +This page describes the dependencies of `licensecc` and the supported build environments. Dependencies varies with the environment, if you're building the library for the first time we suggest you download or set up one of the supported environments to be sure not to incur in dependency/compiler errors (you can use virtual machines , docker or lxc/lxd technologies). -The library is composed by two modules: a license generator `lcc` executable, that also works as a project configuration tool, and the open-license-manager C++ library itself `licensecc` (the part you have to integrate in your application). +The library is composed by two modules: a license generator `lcc` executable, that also works as a project configuration tool, and the C++ library itself `licensecc` (the part you have to integrate in your application). -## Open-license-manager library `licensecc` dependencies +## Library `licensecc` dependencies These are the dependencies of the library you have to link to your code. We try to keep them at a minimum. N.B. boost is always optional and it's never linked to your application. | Operating System | Openssl | Zlib | Boost2 | diff --git a/doc/index.rst b/doc/index.rst index e7b1c534..f5fe6ddb 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -13,8 +13,8 @@ Copy protect, restrict the usage of your C++ software with a license file. .. _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 -.. |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 +.. |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 @@ -35,6 +35,11 @@ A comprehensive :ref:`list of features `, and their 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 `_ (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) ************** The project is donated to the community. It comes with a very large freedom of use for everyone, and it will always be. @@ -46,7 +51,7 @@ Project Structure ******************* 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. +* ``licensecc`` : the C++ library with a C api (the part you have to integrate in your software) with minimal (or no) external dependencies. * ``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 `_ ). @@ -74,8 +79,8 @@ Clone the project. .. code-block:: console - git clone --recursive https://github.com/open-license-manager/open-license-manager.git - cd open-license-manager/ + git clone --recursive https://github.com/open-license-manager/licensecc.git + cd licensecc/ cd build Build on Linux @@ -142,8 +147,8 @@ Otherwise you can open an issue in the `issue system`_. Have a look to the `cont We use `GitFlow`_ (or at least a subset of it). Remember to install the gitflow git plugin and use ``develop`` as default branch for your pull requests. .. _forums: https://groups.google.com/forum/#!forum/licensecc -.. _issue system: https://github.com/open-license-manager/open-license-manager/issues -.. _contribution guidelines: https://github.com/open-license-manager/open-license-manager/blob/develop/CONTRIBUTING.md +.. _issue system: https://github.com/open-license-manager/licensecc/issues +.. _contribution guidelines: https://github.com/open-license-manager/licensecc/blob/develop/CONTRIBUTING.md .. _GitFlow: https://datasift.github.io/gitflow/IntroducingGitFlow.html * :ref:`genindex` diff --git a/doc/other/CREDITS.md b/doc/other/CREDITS.md index 21794f84..4759c565 100644 --- a/doc/other/CREDITS.md +++ b/doc/other/CREDITS.md @@ -1,6 +1,6 @@ # Credits The following open source code has been used in licensecc. -Thanks to every one of the authors of such projects. Without you open license manager would never have been released. +Thanks to every one of the authors of such projects. Without you `licensecc` would never have been released. ## [inja](https://github.com/pantor/inja) A very nice template rendering library used to customize the code. diff --git a/doc/other/QA.md b/doc/other/QA.md index b2dad483..9b64453e 100644 --- a/doc/other/QA.md +++ b/doc/other/QA.md @@ -17,7 +17,7 @@ Every `licensecc` release is tested in the following environments: * Windows server 1809 (MSVC 2017, boost 1.71) * Windows 7-10 (MSVC 2019, boost 1.71) -Tests are carried out automatically every commit. You can see the current build status on [travis-ci](https://travis-ci.org/open-license-manager/open-license-manager). +Tests are carried out automatically every commit. You can see the current build status on [travis-ci](https://travis-ci.org/open-license-manager/licensecc). If you can't get it compiling: @@ -34,20 +34,22 @@ you need to merge the newly generated folder with the one you saved. ## Project statuss ### Project general context (is the project still maintained?) -This project started as a week-end project in 2014, donated and almost forgotten. This doesn't necessarily meant bad. It was "functional". Thanks to the effort of some people that are using it, and to the help of many of you it has been kept up to date (2020). Now it has got a _refresh_ due to some project having interest in it.. +This project started as a week-end project in 2014, donated and almost forgotten. This doesn't necessarily meant bad. It was "functional". Thanks to the effort of some people that are using it, and to the help of many of you it has been kept up to date (2020). Now it has got a _refresh_ due to some project having interest in it and +this year has seen a lot of new features mostly linked to virtualization detection and new environment support. ### Is it production ready? -Let's be honest It is still in alhpa ![experimental](http://badges.github.io/stability-badges/dist/experimental.svg) -stage. This means it's usable with some effort. Some companies are actively using it in production to issue demo licenses and few production licenses. -If you plan to use it in a scenario where you need to issue hundreds of licenses plan some maintaining effort, or better use a more mature or commercial licensing software. +Let's be honest it is still in a very ![experimental](http://badges.github.io/stability-badges/dist/experimental.svg) +stage. This means: it's usable with some effort. Some companies are actively using it in production to issue demo licenses and few production licenses. +If you plan to use it in a scenario where you need to issue hundreds of licenses plan some maintaining effort, +or better use a more mature/commercial licensing software. ### Challenges. The most challenging aspect is the number of environment/libraries we must work with. We've set up automated tests on Travis CI in about 10 different configurations to help contributors to verify their code automatically in conditions they've not thought about. -If you plan to contribute you can quickly check your pull requests are compiling before notifying us by visiting the [travis-ci website](https://travis-ci.org/open-license-manager/open-license-manager). +If you plan to contribute you can quickly check your pull requests are compiling before notifying us by visiting the [travis-ci website](https://travis-ci.org/open-license-manager/licensecc). -### Open License Manager and "the community" -Open License Manager has a very strange relationship with "the community", its aim is to protect proprietary software +### Licensecc and "the community" +`Licensecc` has a very controversal relationship with "the community", its aim is to protect proprietary software from copy and unintended usage. But out there, there are people that think that all the software should be licensed as AGPL... StackOverflow and its fellow sites turned out to be not such a collaborative place to talk about software protection. Remember to choose your questions carefully. :speak_no_evil: \ No newline at end of file diff --git a/doc/other/glossary.rst b/doc/other/glossary.rst index 6f9cfac1..52b9cce9 100644 --- a/doc/other/glossary.rst +++ b/doc/other/glossary.rst @@ -7,7 +7,7 @@ Some `common` word that recur into the documentation have a specific meaning. Be .. glossary:: Project - A project in licensecc terminology usually corresponds to one of your applications where the licensing system need to be integrated. + 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, diff --git a/doc/usage/License-retrieval.md b/doc/usage/License-retrieval.md index 1b5340e8..69339416 100644 --- a/doc/usage/License-retrieval.md +++ b/doc/usage/License-retrieval.md @@ -2,7 +2,7 @@ ## how `licensecc` find the license file -Open License Manager, when integrated into a licensed software can automatically find its license file (or multiple license files) based on: +Licensecc, when integrated into a software can automatically find its license file (or multiple license files) based on: * An environment variable: * Placing the full path of the license file in the environment variable `LICENSE_LOCATION` the library will look for it. Multiple license files can be separated by ';' * Placing the full license content in the environment `LICENSE_DATA` will let the library load it. diff --git a/doc/usage/integration.rst b/doc/usage/integration.rst index 653dd02d..4af9bc48 100644 --- a/doc/usage/integration.rst +++ b/doc/usage/integration.rst @@ -2,7 +2,7 @@ Integrate Licensecc in your application ######################################### -This short guide explain how to integrate `open-license-manager` in your application. +This short guide explain how to integrate `licensecc` in your application. Working examples are provided in the `examples `_ project. diff --git a/doc/usage/issue-licenses.md b/doc/usage/issue-licenses.md index b977bbe6..47dcc237 100644 --- a/doc/usage/issue-licenses.md +++ b/doc/usage/issue-licenses.md @@ -1,7 +1,7 @@ # Issue licenses The easiest way to issue licenses is to enter the project library and create the following project structure: -The projects folder can be anyware. We created one in `open-license-manager/projects` for your convenience (and for testing purposes). A default project1 named `DEFAULT` has been created for you when you configured the project with cmake. +The projects folder can be anyware. We created one in `licensecc/projects` for your convenience (and for testing purposes). A default project1 named `DEFAULT` has been created for you when you configured the project with cmake. You can re-configure the project with the `LCC_PROJECT_NAME` cmake variable to create a new project. ``` @@ -58,4 +58,5 @@ A good way to start exploring available options is the command: `lcc license iss |feature-names | Comma separated list of features to license. See `multi-feature` discussion. | Note: -1 a project is a container for the customizations of open-license-manager. In special way its keys and build parameters. The name should reflect the name of the software you want to add a license to. The project name appears in the license file. \ No newline at end of file +1 a project is a container for the customizations of licensecc. In special way its keys and build parameters. +The name should reflect the name of the software you want to add a license to. The project name appears in the license file. \ No newline at end of file