Skip to content

Commit 7390803

Browse files
milan338milan338
committed
Added readme
1 parent 515ea24 commit 7390803

File tree

3 files changed

+225
-0
lines changed

3 files changed

+225
-0
lines changed

‎CODE_OF_CONDUCT.md

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, religion, or sexual identity
11+
and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the
27+
overall community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or
32+
advances of any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email
36+
address, without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official e-mail address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
[email protected].
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series
87+
of actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or
94+
permanent ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within
114+
the community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.0, available at
120+
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
127+
at [https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md

Whitespace-only changes.

‎README.md

+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
FreeRGB is a highly customisable user interface to control any type of LED lighting, built using Python and PyQt.
2+
3+
## Navigation
4+
5+
- [Navigation](#navigation)
6+
- [Features](#features)
7+
- [Installation](#installation)
8+
- [Prerequisites](#prerequisites)
9+
- [First install](#first-install)
10+
- [Updating](#updating)
11+
- [Usage](#usage)
12+
- [Running](#running)
13+
- [Creating addons](#creating-addons)
14+
- [Contributing](#contributing)
15+
- [Screenshots](#screenshots)
16+
- [ToDo](#todo)
17+
- [License](#license)
18+
19+
## Features
20+
21+
- **Expandable**: Through an easy to use addon system, it is possible to add a limitless range of functionality to FreeRGB, from supporting new types of devices, to creating brand new user-interfaces. Control any device through any communication interface.
22+
- **Customisable**: Through the UI editor, FreeRGB allows creating a custom interface comprised of buttons whose actions are completely custom.
23+
- **Scalable**: Whether you need to control 1 or 100 lighting devices, you can do that. You can also control multiple individual lighting zones per device.
24+
- **Cross-Platform**: Being built using Python and PyQt, any device that supports these should also support FreeRGB. You can control any device through any means of communication, whether it be serial or MQTT, either out-of-the-box or through the addon system.
25+
26+
## Installation
27+
28+
### Prerequisites
29+
30+
- **Python** >= 3.8
31+
32+
### First install
33+
34+
First, you'll need to clone the repo.
35+
```
36+
git clone
37+
```
38+
39+
You'll need to then install the required dependencies. It's a good idea to setup a venv for this.
40+
```
41+
pip install -r requirements.txt
42+
```
43+
44+
### Updating
45+
46+
If you've already cloned the repo and wish to update, simply run
47+
```
48+
git pull origin master
49+
```
50+
51+
## Usage
52+
53+
### Running
54+
55+
To run FreeRGB, you just need to run
56+
```
57+
python FreeRGB.py
58+
```
59+
60+
If using a venv, remember to activate it before running.
61+
62+
Please see the wiki for more information about using the application.
63+
64+
### Creating addons
65+
66+
Addons can be created to:
67+
- Support a new type of device i.e. Yeelight
68+
- Support a new commincation interface i.e. MQTT
69+
- Support running new effect i.e. Colour picker
70+
71+
Please see the wiki for more information about the types of addons that can be created,
72+
and how to create and integrate them.
73+
74+
## Contributing
75+
76+
Before contributing, please ensure you've read the [code of conduct](CODE_OF_CONDUCT.md).
77+
78+
If you'd like to contribute to the project, please see the [guidelines](CONTRIBUTING.md).
79+
80+
## Screenshots
81+
82+
## ToDo
83+
84+
- [ ] Support for MQTT communication
85+
- [ ] Background service allowing other applications to control lighting
86+
- [ ] Built-in updates
87+
- [ ] Distribution through package deployment
88+
- [ ] CI pipelines
89+
90+
## License
91+
92+
[GNU General Public License (version 3)](LICENSE)

0 commit comments

Comments
 (0)