Initial commit
This commit is contained in:
34
README.md
Normal file
34
README.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# EG
|
||||
|
||||
## Description
|
||||
This repository contains eg or "for example" files. That includes this README and LICENSE.
|
||||
`~/eg`is a $HOME directory for me and is marked as an XDG template folder.
|
||||
This allows you to easily create files from "templates" on a desktop.
|
||||
It also serves as a filepath `~/eg` for scripts and automation.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Description](#description)
|
||||
- [Features](#features)
|
||||
- [Usage](#usage)
|
||||
- [Credits / Resources](#credits--resources)
|
||||
- [License](#license)
|
||||
|
||||
## Features
|
||||
+ Easy to copy.
|
||||
+ Defaults to revert to.
|
||||
+ Templates for easy productivity.
|
||||
|
||||
|
||||
## Usage
|
||||
Just copy and paste into your projects.<br>
|
||||
/dev - Files used in development.<br>
|
||||
/dot - Files used in configuration.<br>
|
||||
|
||||
## Credits / Resources
|
||||
[Tom Preston-Werner README Driven Development](https://tom.preston-werner.com/2010/08/23/readme-driven-development)<br>
|
||||
[Make a README](https://www.makeareadme.com/)<br>
|
||||
[Choose a LICENSE](https://choosealicense.com/)<br>
|
||||
|
||||
## License
|
||||
This project is licensed under MIT - see the [LICENSE](LICENSE) file for details.
|
||||
Reference in New Issue
Block a user