- Go to new Repository
- Select this repository template
- Choose the owner
- Add a name to your repository
- Set a description (optional)
- Set the visibility
- Click the
"Create repository"
button.
- 1.1 Get started
- 2.1 Content
- 3.1 Documentation
- 4.1 License
Everything is documented right here π
Get started
contains a guide to install the project.
Here's an example:
## Get started
1. Step
2. Step
3. Step
4. ...
Content
is basically a feature list.
Here's an example:
## Content
- 1.1 [Feature #1](link-to-feature-#1)
- 2.1 [Feature #2](link-to-feature-#2)
- 3.1 [Feature #3](link-to-feature-#3)
- 4.1 ...
Documentation
describes those features in detail.
Here's an example:
## Documentation
General description
### 1.1 Feature #1
Short description + example
### 2.1 Feature #2
Short description + example
### 3.1 Feature #3
Short description + example
### 4.1 Feature #4
...
License
defines which license is used for this project.
Here's an example:
MIT License<br>
Copyright Β© [year] [fullname]
MIT License
Copyright Β© 2023 - present, Noel KΓΌng