70 lines
1.3 KiB
Markdown
70 lines
1.3 KiB
Markdown
|
# eg
|
||
|
|
|
||
|
|
## Description
|
||
|
|
EG or "for example" files, contain files (like this README) that serve as
|
||
|
|
good examples and file templates. If you set this directory to your
|
||
|
|
XDG Templates in `/etc/xdg/user-dirs.defaults` like so `Templates=eg`,
|
||
|
|
you can use the dropdown menu to easily create files.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Table of Contents
|
||
|
|
|
||
|
|
* [Features](#features)
|
||
|
|
* [Todos](#todos)
|
||
|
|
* [Usage](#usage)
|
||
|
|
* [Acknowledgments](#acknowledgments)
|
||
|
|
* [License](#license)
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
* Easily create files from templates.
|
||
|
|
* GUI support with XDG.
|
||
|
|
* The directory bash scripts reference for templates.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Todos
|
||
|
|
|
||
|
|
* [ ] Add new feature X
|
||
|
|
* [ ] Improve documentation
|
||
|
|
* [ ] Write tests
|
||
|
|
* [ ] Optimize performance
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Provide instructions and examples on how to use your project.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# Example installation
|
||
|
|
git clone https://github.com/your-username/your-repo.git
|
||
|
|
|
||
|
|
# Navigate into the directory
|
||
|
|
cd your-repo
|
||
|
|
|
||
|
|
# Run the project
|
||
|
|
npm install
|
||
|
|
npm start
|
||
|
|
```
|
||
|
|
|
||
|
|
You can also include code snippets or screenshots demonstrating usage.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Acknowledgments
|
||
|
|
|
||
|
|
[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 the MIT License - see the [LICENSE] file for details.
|
||
|
|
|