Skip to content

Commit 0aa5def

Browse files
Witty-WizardWitty-Wizard
committed
Initial Commit
0 parents  commit 0aa5def

31 files changed

Lines changed: 4775 additions & 0 deletions

‎.clang-format‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
AccessModifierOffset: -2
2+
AlignAfterOpenBracket: Align
3+
AlignConsecutiveAssignments: false
4+
AlignConsecutiveDeclarations: false
5+
AlignEscapedNewlinesLeft: false
6+
AlignOperands: true
7+
AlignTrailingComments: true
8+
AllowAllParametersOfDeclarationOnNextLine: false
9+
AllowShortBlocksOnASingleLine: false
10+
AllowShortCaseLabelsOnASingleLine: false
11+
AllowShortFunctionsOnASingleLine: Inline
12+
AllowShortIfStatementsOnASingleLine: false
13+
AllowShortLoopsOnASingleLine: false
14+
AlwaysBreakAfterDefinitionReturnType: TopLevel
15+
AlwaysBreakAfterReturnType: TopLevelDefinitions
16+
AlwaysBreakBeforeMultilineStrings: false
17+
AlwaysBreakTemplateDeclarations: true
18+
BinPackArguments: false
19+
BinPackParameters: true
20+
BraceWrapping:
21+
AfterClass: true
22+
AfterControlStatement: false
23+
AfterEnum: true
24+
AfterFunction: true
25+
AfterNamespace: false
26+
AfterObjCDeclaration: false
27+
AfterStruct: true
28+
AfterUnion: true
29+
BeforeCatch: false
30+
BeforeElse: true
31+
IndentBraces: false
32+
BreakBeforeBinaryOperators: None
33+
BreakBeforeBraces: Custom
34+
BreakBeforeTernaryOperators: true
35+
BreakConstructorInitializersBeforeComma: true
36+
ColumnLimit: 79
37+
CommentPragmas: '^ IWYU pragma:'
38+
ConstructorInitializerAllOnOneLineOrOnePerLine: true
39+
ConstructorInitializerIndentWidth: 2
40+
ContinuationIndentWidth: 2
41+
Cpp11BracedListStyle: false
42+
DerivePointerAlignment: false
43+
DisableFormat: false
44+
ExperimentalAutoDetectBinPacking: false
45+
ForEachMacros: [ foreach, Q_FOREACH, BOOST_FOREACH ]
46+
IncludeCategories:
47+
- Regex: '^"(llvm|llvm-c|clang|clang-c)/'
48+
Priority: 2
49+
- Regex: '^(<|"(gtest|isl|json)/)'
50+
Priority: 3
51+
- Regex: '.*'
52+
Priority: 1
53+
IndentCaseLabels: false
54+
IndentWidth: 2
55+
IndentWrappedFunctionNames: false
56+
KeepEmptyLinesAtTheStartOfBlocks: true
57+
MacroBlockBegin: ''
58+
MacroBlockEnd: ''
59+
MaxEmptyLinesToKeep: 1
60+
NamespaceIndentation: None
61+
ObjCBlockIndentWidth: 2
62+
ObjCSpaceAfterProperty: true
63+
ObjCSpaceBeforeProtocolList: false
64+
PointerAlignment: Right
65+
ReflowComments: true
66+
SortIncludes: false
67+
SpaceAfterCStyleCast: false
68+
SpaceBeforeAssignmentOperators: true
69+
SpaceBeforeParens: Never
70+
SpaceInEmptyParentheses: false
71+
SpacesBeforeTrailingComments: 1
72+
SpacesInAngles: false
73+
SpacesInContainerLiterals: true
74+
SpacesInCStyleCastParentheses: false
75+
SpacesInParentheses: false
76+
SpacesInSquareBrackets: false
77+
Standard: Cpp11
78+
TabWidth: 8
79+
UseTab: Never

‎.github/CODEOWNERS‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Define code ownership for the entire repository
2+
* @Witty-Wizard

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: 🐛 Bug Report
2+
description: Create a bug report to help us resolving the bug
3+
title: "🐛 Bug: "
4+
labels: ["bug 🐛"]
5+
assignees:
6+
- Witty-Wizard
7+
8+
body:
9+
- type: textarea
10+
id: bug-description
11+
attributes:
12+
label: Describe the bug
13+
description: |
14+
Please provide a clear and concise description of the bug. Include any relevant details, such as error messages, unexpected behavior, or steps to reproduce the issue.
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
id: steps-to-reproduce
20+
attributes:
21+
label: Steps to Reproduce
22+
description: |
23+
Please provide a list of steps to reproduce the bug. This will help us understand how to replicate the issue.
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: expected-behavior
29+
attributes:
30+
label: Expected Behavior
31+
description: |
32+
Please describe what you expected to happen. This will help us understand the intended functionality.
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: Additional-context
38+
attributes:
39+
label: Additional Context
40+
description: |
41+
Please provide any additional context or information that may be relevant to the bug report. This could include screenshots, logs, or any other details that may help us understand the issue better.
42+
validations:
43+
required: false

‎.github/ISSUE_TEMPLATE/docs.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: 📖 Documentation
2+
description: Propose changes and improvements to Docs.
3+
title: "📖 Docs: "
4+
labels: ["documentation 📖"]
5+
assignees:
6+
- Witty-Wizard
7+
8+
body:
9+
- type: textarea
10+
id: issue-description
11+
attributes:
12+
label: "Describe the issue or improvement you want to propose"
13+
description: "Provide a clear description of the changes you're proposing for the documentation. Are you suggesting corrections, clarifications, additions, or updates?"
14+
placeholder: "Describe the improvement..."
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
id: issue-why
20+
attributes:
21+
label: "Why do the Docs need this improvement?"
22+
description: "Explain the motivation behind the proposed changes and how they will benefit the community or users of the documentation."
23+
placeholder: "Explain why this change is needed..."
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: issue-solution
29+
attributes:
30+
label: "What is the proposed solution?"
31+
description: "Outline the specific changes or additions you would like to see in the documentation. Be as detailed as possible."
32+
placeholder: "Describe the solution..."
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: additional-context
38+
attributes:
39+
label: "Additional context"
40+
description: "If applicable, provide any additional context, examples, or screenshots related to the proposed documentation changes."
41+
placeholder: "Add any additional context..."
42+
validations:
43+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: "🪄 Feature Request"
2+
description: "Suggest an interesting feature idea for this project"
3+
title: "🪄 Feature: "
4+
labels: ["enhancement 🪄"]
5+
assignees:
6+
- Witty-Wizard
7+
8+
body:
9+
- type: textarea
10+
id: problem-description
11+
attributes:
12+
label: "Is your feature request related to a problem? Please describe."
13+
description: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]"
14+
placeholder: "Describe the problem..."
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
id: solution-description
20+
attributes:
21+
label: "Describe the solution you'd like"
22+
description: "A clear and concise description of what you want to happen."
23+
placeholder: "Describe the desired solution..."
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: alternatives-description
29+
attributes:
30+
label: "Describe alternatives you've considered"
31+
description: "A clear and concise description of any alternative solutions or features you've considered."
32+
placeholder: "Describe alternative solutions..."
33+
validations:
34+
required: false
35+
36+
- type: textarea
37+
id: additional-context
38+
attributes:
39+
label: "Additional context"
40+
description: "Add any other context or screenshots about the feature request here."
41+
placeholder: "Add additional context..."
42+
validations:
43+
required: false

‎.github/workflows/arduinio_ci.yaml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Arduino CI
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
arduino_ci:
7+
runs-on: ubuntu-latest
8+
9+
steps:
10+
- name: Checkout Repository
11+
uses: actions/checkout@v4
12+
13+
- name: Arduino Continuous Integration
14+
uses: Arduino-CI/action@latest

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/Docs/html
2+
/Docs/latex

‎.readthedocs.yaml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Read the Docs configuration file
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
# Required
5+
version: 2
6+
7+
# Set the OS, Python version, and other tools you might need
8+
build:
9+
os: ubuntu-24.04
10+
tools:
11+
python: "3.10"
12+
apt_packages:
13+
- doxygen
14+
15+
# Build documentation in the "docs/" directory with Sphinx
16+
sphinx:
17+
configuration: Docs/source/conf.py
18+
19+
# Optionally, but recommended,
20+
# declare the Python requirements required to build your documentation
21+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
22+
python:
23+
install:
24+
- requirements: Docs/requirements.txt
25+

‎CODE_OF_CONDUCT.md‎

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

0 commit comments

Comments
 (0)