|
|
Here's a sample README.md for your use.
|
|
|
|
|
|
Create a README.md at the root of your repository with the following contents:
|
|
|
```
|
|
|
# MyProductName
|
|
|
A description of the product goes here.
|
|
|
|
|
|
by super_awesome_dev
|
|
|
original file by another_developer
|
|
|
|
|
|
## Description
|
|
|
Here's the long form description, listing features and whatnot of the product here.
|
|
|
|
|
|
## Variants
|
|
|
- **Variant 1** - Listed release variant 1 description here.
|
|
|
- **Variant 2** - Ditto for variant 2.
|
|
|
|
|
|
This section is optional if you have just one version.
|
|
|
|
|
|
## Materials Required
|
|
|
You will need a set of each below for each [x] you make.
|
|
|
- x1 **Parts Kit** - Procure a parts kit of your preference.
|
|
|
- x1 **Steel Spring** - this is for retaining the magazine release button
|
|
|
|
|
|
## Instructions
|
|
|
1. It would help to include printing instructions, i.e, orientation, support usage, temperature, line numbers/width, etc.
|
|
|
2. Keep your steps easy to read, and digestiable.
|
|
|
|
|
|
Pro-tip: A helpful tip can be insert here too.
|
|
|
|
|
|
## Change Log
|
|
|
|
|
|
- v1.0: Version 1 Release
|
|
|
* Documentation update.
|
|
|
|
|
|
- v0.2: Private Beta Candidate 2
|
|
|
* Product update change goes here
|
|
|
* and here too!
|
|
|
|
|
|
- v0.1: Private Beta Candidate 1
|
|
|
* Initial commit
|
|
|
|
|
|
## License
|
|
|
MIT License or GNU Licenses are great places to look at for open source software.
|
|
|
``` |
|
|
\ No newline at end of file |