Initial commit
This commit is contained in:
50
README.md
Normal file
50
README.md
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
# dot
|
||||||
|
|
||||||
|
## Description
|
||||||
|
There is no place like $HOME. Home directory setup and bootstrapping guide.
|
||||||
|
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
* [Features](#features)
|
||||||
|
* [Todos](#todos)
|
||||||
|
* [Usage](#usage)
|
||||||
|
* [Acknowledgments](#acknowledgments)
|
||||||
|
* [License](#license)
|
||||||
|
|
||||||
|
|
||||||
|
## Features
|
||||||
|
- [ ] Dotfiles
|
||||||
|
- [ ] XDG
|
||||||
|
- [ ] Setup Scripts
|
||||||
|
|
||||||
|
## Todos
|
||||||
|
|
||||||
|
## 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>
|
||||||
|
[Atlassian - How to store Dotfiles](https://www.atlassian.com/git/tutorials/dotfiles)<br>
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
|
||||||
Reference in New Issue
Block a user