initial commit

This commit is contained in:
2026-04-06 13:54:55 -05:00
commit 8c70bbd9f3
2 changed files with 90 additions and 0 deletions

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) [year] [fullname]
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

69
README.md Normal file
View File

@@ -0,0 +1,69 @@
# 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.