# Template Documentaion
This template works by using a set of CHANGEME tags across the whole repository
and using a python script it changes all of those tags to match your repository,
making it seem just as if you built everything from the ground up specifically
for your project. For a full list of features this template has read
[Features](template/FEATURES.md).
**For this template to work with no changes make sure to choose a repository
name that is not present on crates.io or in the AUR**
**Required to follow**: [How to Start](template/START.md) &
[Requirements](template/REQ.md)
**For proper use give a read**: [Features](template/FEATURES.md) &
[Workflow](template/WORKFLOW.md)
**Before first release**: you should read the rest
- [How to Start](template/START.md) - Instructions on the first things you
should do using this template
- [Requirements](template/REQ.md) - Things you need to change to make this
repository fully work
- [Features](template/FEATURES.md) - Features of this template
- [Workflow](template/WORKFLOW.md) - Instructions on the proper use of this
template and what [I](https://github.com/Obscurely) think is the "best" way to
program using RUST
- [Update the Logo](template/UPDATE_LOGO.md) - Instructions on how to update the
logo using the provided script.
- [Update the Description](template/UPDATE_DESC.md) - Instructions on how to
update the _short_ description using the provided script.
- [Manual Changes](template/MANUAL.md) - Things you have to change manually,
like features of your project, **not required**
- [Extras](template/EXTRAS.md) - Extra things to change if you wanna make your
repository better, **not required/just 2 sections if you want to follow
[my](https://github.com/Obscurely) [Workflow](template/WORKFLOW.md)**