2026-04-15 12:19:20 -05:00
|
|
|
# dot
|
|
|
|
|
|
|
|
|
|
## Description
|
|
|
|
|
There is no place like $HOME. Home directory setup and bootstrapping guide.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Table of Contents
|
|
|
|
|
|
2026-04-15 13:01:00 -05:00
|
|
|
* [XDG](#xdg)
|
2026-04-15 12:53:15 -05:00
|
|
|
* [Directories](#directories)
|
2026-04-15 13:01:00 -05:00
|
|
|
* [Dotfiles](#dotfiles)
|
2026-04-15 12:19:20 -05:00
|
|
|
* [Usage](#usage)
|
|
|
|
|
* [Acknowledgments](#acknowledgments)
|
|
|
|
|
* [License](#license)
|
|
|
|
|
|
|
|
|
|
|
2026-04-15 13:01:00 -05:00
|
|
|
## XDG
|
2026-04-15 12:53:15 -05:00
|
|
|
xdg-user-dirs is a tool to help manage "well known" user directories like the
|
|
|
|
|
desktop folder and the music folder. It also handles localization
|
|
|
|
|
(i.e. translation) of the filenames.
|
|
|
|
|
|
|
|
|
|
xdg-user-dirs-update is ran early in the login phase. It reads a configuration
|
|
|
|
|
file `/etc/xdg/xdg-user-dirs.defaults`. You should replace this file as root
|
2026-04-15 13:01:00 -05:00
|
|
|
before logging in or opening the file manager. I usually truncate the original
|
|
|
|
|
names, and add a few more directories.
|
|
|
|
|
|
|
|
|
|
You can find the original `/etc/xdg/xdg-user-dirs.defaults`[Here]()<- TODO
|
|
|
|
|
You can find the custom `/etc/xdg/xdg-user-dirs.defaults`[Here]()<- TODO
|
|
|
|
|
|
|
|
|
|
TODO add script to grab eg file and replace.
|
|
|
|
|
|
|
|
|
|
## Directories
|
2026-04-15 12:19:20 -05:00
|
|
|
|
2026-04-15 13:01:00 -05:00
|
|
|
## Dotfiles
|
2026-04-15 12:19:20 -05:00
|
|
|
|
|
|
|
|
## 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
|
|
|
|
|
|
|
|
|
|
|
