Template for eclean.gg public GitHub repositories
Visit website »
Feedback · Public wiki · Public blog
A short piece of writing about the repository and how it can help the reader. Every repository should always have a purpose that is clear and well-known.
- A list of all the prerequisites, with links (e.g. download).
- Step-by-step instructions with numbers to help the user build the repository on their own.
- Feel free to add notes where appropriate.
- Steps, like cloning the repository, can be skipped, but it's important to know what they are.
YOUR_VARIABLE
— A short description for the variable
CONFIG_OPTION
— A short description for the config option
If the product you're making will be used commercially, write a list of the packages and dependencies you need under this heading. You don't have to write down the sub-dependencies. See the example below.