Skip to content

Commit a9c179d

Browse files
aeratertaaeraterta
authored
Merge pull request #1 from aeraterta/main
Update template
2 parents f4eaf11 + ac64140 commit a9c179d

File tree

11 files changed

+306
-2
lines changed

11 files changed

+306
-2
lines changed

‎.github/workflows/deploy.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: ci
2+
on:
3+
push:
4+
branches:
5+
- master
6+
- main
7+
permissions:
8+
contents: write
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- uses: actions/setup-python@v4
15+
with:
16+
python-version: 3.x
17+
- uses: actions/cache@v2
18+
with:
19+
key: ${{ github.ref }}
20+
path: .cache
21+
- run: pip install --upgrade pip
22+
- run: pip install -r requirements.txt
23+
- run: pip install mkdocs-material
24+
- run: pip install pillow cairosvg
25+
- run: mkdocs gh-deploy --force

‎.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/site
2+
/raw
3+
4+
/env

‎README.md

Lines changed: 79 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,79 @@
1-
# wiki
2-
mcu-dev documentation
1+
# mcu-dev Documentation
2+
3+
MCU-Dev is dedicated to fostering innovation and collaboration in the embedded systems community by creating and sharing reusable projects, drivers, and applications. Our mission is to provide high-quality, open-source resources that anyone can freely copy, use, and modify, enabling developers worldwide to accelerate their projects and push the boundaries of what's possible with microcontroller technology. Through our commitment to open collaboration, we aim to empower engineers and hobbyists alike to build more efficient, reliable, and creative solutions.
4+
5+
## Links:
6+
7+
- MKDocs: [https://mcu-dev.github.io/documentation](https://mcu-dev.github.io/documentation/)
8+
9+
## How to Contribute
10+
11+
### Fork the Repository
12+
13+
- Sign in to GitHub: Ensure you're signed in to your GitHub account. If you don’t have one, you’ll need to create it.
14+
- Navigate to the Repository: Go to the MCU-Dev GitHub repository you want to contribute to.
15+
- Fork the Repository: Click the "Fork" button at the top right corner of the repository page. This creates a personal copy of the repository under your GitHub account.
16+
17+
### Clone Your Fork
18+
19+
Clone to Your Local Machine: Open your terminal or command prompt, and clone your forked repository using the following command:
20+
21+
git clone https://github.com/YOUR-USERNAME/REPOSITORY-NAME.git
22+
23+
### Create a New Branch
24+
25+
- Create and Switch to a New Branch: It’s good practice to create a new branch for each feature or bug fix you’re working on. This keeps your changes isolated and makes it easier to manage pull requests. Create a new branch using:
26+
27+
```
28+
git checkout -b your-branch-name
29+
```
30+
31+
### Make Your Changes
32+
33+
- Edit the Code: Make the necessary changes in the codebase. This could be fixing a bug, adding a new feature, improving documentation, or any other contribution.
34+
- Test Your Changes: Before committing, make sure to test your changes to ensure everything works as expected.
35+
36+
### Commit Your Changes
37+
38+
- Stage Your Changes: Add the files you’ve modified to the staging area:
39+
40+
```
41+
git add .
42+
```
43+
44+
- Commit with a Message: Commit your changes with a clear and concise commit message:
45+
46+
```
47+
git commit -m "Your descriptive commit message"
48+
```
49+
50+
### Push Your Changes to GitHub
51+
52+
- Push the Changes: Push your branch to your GitHub fork:
53+
54+
```
55+
git push origin your-branch-name
56+
```
57+
58+
### Create a Pull Request
59+
60+
- Navigate to the Original Repository: Go back to the original MCU-Dev repository on GitHub.
61+
- Compare & Pull Request: You’ll see a prompt to compare the branches and create a pull request. Click on the "Compare & pull request" button.
62+
- Fill Out the PR Form: Provide a title and description for your pull request, explaining what changes you’ve made and why they should be merged.
63+
- Submit the Pull Request: Click "Create pull request" to submit your changes for review.
64+
65+
### Collaborate on the Review
66+
67+
- Address Feedback: The project maintainers may provide feedback or request changes. Be sure to address any comments and push updates to your branch as needed.
68+
- Merge Your Changes: Once your pull request is approved, it will be merged into the main repository. In some cases, the maintainers will ask you to merge it yourself.
69+
70+
### Keep Your Fork Updated
71+
72+
- Sync with Upstream: To keep your fork updated with the latest changes from the original repository, you can add the original repository as an upstream remote and pull in the latest changes:
73+
74+
```
75+
git remote add upstream https://github.com/ORIGINAL-OWNER/REPOSITORY-NAME.git
76+
git fetch upstream
77+
git checkout main
78+
git merge upstream/main
79+
```

‎docs/assets/attiny402-pinout.png

1.35 MB
Loading

‎docs/assets/attiny402-ssf.png

543 KB
Loading

‎docs/assets/lsm303a.png

56 KB
Loading

‎docs/index.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Welcome to mcu-dev Documentation
2+
3+
MCU-Dev is dedicated to fostering innovation and collaboration in the embedded systems community by creating and sharing reusable projects, drivers, and applications. Our mission is to provide high-quality, open-source resources that anyone can freely copy, use, and modify, enabling developers worldwide to accelerate their projects and push the boundaries of what's possible with microcontroller technology. Through our commitment to open collaboration, we aim to empower engineers and hobbyists alike to build more efficient, reliable, and creative solutions.
4+
5+
6+
## How to Contribute
7+
8+
### Fork the Repository
9+
10+
- Sign in to GitHub: Ensure you're signed in to your GitHub account. If you don’t have one, you’ll need to create it.
11+
- Navigate to the Repository: Go to the MCU-Dev GitHub repository you want to contribute to.
12+
- Fork the Repository: Click the "Fork" button at the top right corner of the repository page. This creates a personal copy of the repository under your GitHub account.
13+
14+
### Clone Your Fork
15+
16+
Clone to Your Local Machine: Open your terminal or command prompt, and clone your forked repository using the following command:
17+
18+
git clone https://github.com/YOUR-USERNAME/REPOSITORY-NAME.git
19+
20+
### Create a New Branch
21+
22+
- Create and Switch to a New Branch: It’s good practice to create a new branch for each feature or bug fix you’re working on. This keeps your changes isolated and makes it easier to manage pull requests. Create a new branch using:
23+
24+
```
25+
git checkout -b your-branch-name
26+
```
27+
28+
### Make Your Changes
29+
30+
- Edit the Code: Make the necessary changes in the codebase. This could be fixing a bug, adding a new feature, improving documentation, or any other contribution.
31+
- Test Your Changes: Before committing, make sure to test your changes to ensure everything works as expected.
32+
33+
### Commit Your Changes
34+
35+
- Stage Your Changes: Add the files you’ve modified to the staging area:
36+
37+
```
38+
git add .
39+
```
40+
41+
- Commit with a Message: Commit your changes with a clear and concise commit message:
42+
43+
```
44+
git commit -m "Your descriptive commit message"
45+
```
46+
47+
### Push Your Changes to GitHub
48+
49+
- Push the Changes: Push your branch to your GitHub fork:
50+
51+
```
52+
git push origin your-branch-name
53+
```
54+
55+
### Create a Pull Request
56+
57+
- Navigate to the Original Repository: Go back to the original MCU-Dev repository on GitHub.
58+
- Compare & Pull Request: You’ll see a prompt to compare the branches and create a pull request. Click on the "Compare & pull request" button.
59+
- Fill Out the PR Form: Provide a title and description for your pull request, explaining what changes you’ve made and why they should be merged.
60+
- Submit the Pull Request: Click "Create pull request" to submit your changes for review.
61+
62+
### Collaborate on the Review
63+
64+
- Address Feedback: The project maintainers may provide feedback or request changes. Be sure to address any comments and push updates to your branch as needed.
65+
- Merge Your Changes: Once your pull request is approved, it will be merged into the main repository. In some cases, the maintainers will ask you to merge it yourself.
66+
67+
### Keep Your Fork Updated
68+
69+
- Sync with Upstream: To keep your fork updated with the latest changes from the original repository, you can add the original repository as an upstream remote and pull in the latest changes:
70+
71+
```
72+
git remote add upstream https://github.com/ORIGINAL-OWNER/REPOSITORY-NAME.git
73+
git fetch upstream
74+
git checkout main
75+
git merge upstream/main
76+
```

‎docs/javascript/mathjax.js

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
window.MathJax = {
2+
tex: {
3+
inlineMath: [["\\(", "\\)"]],
4+
displayMath: [["\\[", "\\]"]],
5+
processEscapes: true,
6+
processEnvironments: true
7+
},
8+
options: {
9+
ignoreHtmlClass: ".*|",
10+
processHtmlClass: "arithmatex"
11+
}
12+
};
13+
14+
document$.subscribe(() => {
15+
MathJax.typesetPromise()
16+
})
17+

‎docs/stylesheets/extra.css

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:root {
2+
--md-admonition-icon--screenshot: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M64 0C28.7 0 0 28.7 0 64v288c0 35.3 28.7 64 64 64h176l-10.7 32H160c-17.7 0-32 14.3-32 32s14.3 32 32 32h256c17.7 0 32-14.3 32-32s-14.3-32-32-32h-69.3L336 416h176c35.3 0 64-28.7 64-64V64c0-35.3-28.7-64-64-64H64zm448 64v288H64V64h448z"/></svg>')
3+
}
4+
.md-typeset .admonition.screenshot,
5+
.md-typeset details.screenshot {
6+
border-color: rgb(43, 155, 70);
7+
background-color: rgb(210, 210, 210);
8+
}
9+
.md-typeset .screenshot > .admonition-title,
10+
.md-typeset .screenshot > summary {
11+
background-color: rgb(65, 233, 105, 0.3);
12+
}
13+
.md-typeset .screenshot > .admonition-title::before,
14+
.md-typeset .screenshot > summary::before {
15+
background-color: rgb(43, 155, 70);
16+
-webkit-mask-image: var(--md-admonition-icon--screenshot);
17+
mask-image: var(--md-admonition-icon--screenshot);
18+
}

‎mkdocs.yml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
site_name: mcu-dev Wiki Pages
2+
site_url: https://mcu-dev.github.io/documentation/
3+
nav:
4+
- Home: index.md
5+
theme:
6+
name: material
7+
features:
8+
- navigation.tabs
9+
- navigation.sections
10+
- toc.integrate
11+
- navigation.top
12+
- search.suggest
13+
- search.highlight
14+
- content.tabs.link
15+
- content.code.annotation
16+
- content.code.copy
17+
language: en
18+
palette:
19+
- scheme: default
20+
toggle:
21+
icon: material/toggle-switch-off-outline
22+
name: Switch to dark mode
23+
primary: blue
24+
accent: purple
25+
- scheme: slate
26+
toggle:
27+
icon: material/toggle-switch
28+
name: Switch to light mode
29+
primary: blue
30+
accent: lime
31+
plugins:
32+
- search
33+
- drawio_file
34+
- print-site
35+
markdown_extensions:
36+
- admonition
37+
- pymdownx.details
38+
- pymdownx.superfences
39+
- pymdownx.tabbed:
40+
alternate_style: true
41+
- toc:
42+
permalink: true
43+
toc_depth: 3
44+
- pymdownx.arithmatex:
45+
generic: true
46+
extra_css:
47+
- stylesheets/extra.css
48+
extra_javascript:
49+
- javascripts/mathjax.js
50+
- https://polyfill.io/v3/polyfill.min.js?features=es6
51+
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
52+
53+
copyright: |
54+
&copy; 2024 <a href="https://github.com/orgs/mcu-dev/dashboard" target="_blank" rel="noopener">mcu-dev</a>

0 commit comments

Comments
 (0)