Skip to content

Commit 0fc8d1e

Browse files
author
umit.kacar
committed
feat: Add awesome list enhancement with hybrid README format
- Create hybrid README (awesome list + Python package docs) - Add CODE_OF_CONDUCT.md (Contributor Covenant v2.1) - Setup MkDocs Material for GitHub Pages - Add social card for OpenGraph sharing (1200x630px) - Add PR and Issue templates - Add MkDocs deployment workflow - Remove .github/ from gitignore (needed for Actions) - Create docs/ folder with all documentation Awesome list includes: - 60+ curated TinyML resources - 11 categories: Hardware, Frameworks, Compression, Tools, etc. - Awesome badge and standards compliance Python package features retained: - Model quantization, optimization, pruning - Inference engine with 94% test coverage Site: https://umitkacar.github.io/awesome-tinyml
1 parent 3a552bd commit 0fc8d1e

File tree

13 files changed

+2958
-1364
lines changed

13 files changed

+2958
-1364
lines changed

‎.github/ISSUE_TEMPLATE/suggest-resource.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Suggest Resource
3+
about: Suggest a new resource for the awesome list
4+
title: '[SUGGESTION] '
5+
labels: 'suggestion'
6+
assignees: ''
7+
---
8+
9+
## Resource Information
10+
11+
**Name**:
12+
**URL**:
13+
**Category**:
14+
**Description**:
15+
16+
## Why is this resource awesome?
17+
18+
19+
## Have you used this resource?
20+
21+
- [ ] Yes, I've used it personally
22+
- [ ] No, but it's highly recommended by the community
23+
- [ ] I'm the author/maintainer
24+
25+
## Additional context
26+
27+
Add any other context about the resource here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## Adding/Updating Resource
2+
3+
**Resource Name**:
4+
**Category**:
5+
**URL**:
6+
7+
## Description
8+
9+
Briefly describe what this resource is and why it's awesome:
10+
11+
12+
13+
## Quality Checklist
14+
15+
- [ ] I have used this resource personally OR can vouch for its quality
16+
- [ ] The resource is actively maintained (updated within last 12 months)
17+
- [ ] The resource has clear documentation
18+
- [ ] The link works and points to the correct resource
19+
- [ ] The description is concise (1-2 sentences)
20+
- [ ] Entry is in alphabetical order within category
21+
- [ ] Entry follows format: `- [Name](url#readme) - Description.`
22+
- [ ] I have run `awesome-lint` and fixed issues
23+
- [ ] I have read the [contribution guidelines](CONTRIBUTING.md)
24+
- [ ] I have read the [Code of Conduct](CODE_OF_CONDUCT.md)
25+
26+
## Additional Context
27+
28+
How did you discover this resource? Why do you think it belongs in this list?
29+
30+

‎.github/workflows/deploy.yml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Deploy MkDocs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: write
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: false
16+
17+
jobs:
18+
deploy:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout repository
22+
uses: actions/checkout@v4
23+
with:
24+
fetch-depth: 0
25+
26+
- name: Setup Python
27+
uses: actions/setup-python@v5
28+
with:
29+
python-version: 3.x
30+
31+
- name: Cache dependencies
32+
uses: actions/cache@v3
33+
with:
34+
path: ~/.cache/pip
35+
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
36+
restore-keys: |
37+
${{ runner.os }}-pip-
38+
39+
- name: Install dependencies
40+
run: |
41+
pip install mkdocs-material
42+
pip install mkdocs-minify-plugin
43+
44+
- name: Build documentation
45+
run: mkdocs build --verbose --strict
46+
47+
- name: Deploy to GitHub Pages
48+
run: mkdocs gh-deploy --force --message "docs: Deploy documentation [skip ci]"

‎.gitignore‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,4 +198,3 @@ htmlcov/
198198

199199
# Ruff
200200
.ruff_cache/
201-
.github/

‎CODE_OF_CONDUCT.md‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
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, caste, color, religion, or sexual
10+
identity 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 overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
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 address,
35+
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+
umitkacar.phd@gmail.com.
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 of
86+
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 permanent
93+
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 the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

0 commit comments

Comments
 (0)