Skip to content

Commit

Permalink
repo rename: open-license-manager -> licensecc
Browse files Browse the repository at this point in the history
  • Loading branch information
gcontini committed Nov 22, 2020
1 parent 6d2ab57 commit 0fd6615
Show file tree
Hide file tree
Showing 17 changed files with 97 additions and 90 deletions.
53 changes: 25 additions & 28 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,73 @@
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.

If you have already forked the repository to implement a specific feature, and you want your code to be merged in the main repository please first file an enhancement request as explained in [suggesting enhancements](#suggesting-enhancements-or-new-features). If you found a bug and you want to propose a fix please [report a bug](#reporting-bugs) before.

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.

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
33 changes: 17 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,55 @@
# 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 <a class="github-button" href="https://github.com/open-license-manager/open-license-manager" data-icon="octicon-star" aria-label="Star open-license-manager/open-license-manager on GitHub">star</a> here on GitHub.
Remember to show your appreciation giving us a <a class="github-button" href="https://github.com/open-license-manager/licensecc" data-icon="octicon-star" aria-label="Star open-license-manager/licensecc on GitHub">star</a> 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
- compilers : GCC (Linux) MINGW (Linux cross compile for Windows), MINGW or MSVC (Windows)
- 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
Expand Down Expand Up @@ -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.
Loading

0 comments on commit 0fd6615

Please sign in to comment.