78 lines
1.9 KiB
Markdown
78 lines
1.9 KiB
Markdown
# dot
|
|
|
|
## Description
|
|
There is no place like $HOME. Home directory setup and bootstrapping guide.
|
|
|
|
|
|
## Table of Contents
|
|
|
|
* [Directories](#directories)
|
|
* [Todos](#todos)
|
|
* [Usage](#usage)
|
|
* [Acknowledgments](#acknowledgments)
|
|
* [License](#license)
|
|
|
|
|
|
## Directories
|
|
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
|
|
before logging in or opening the file manager. Here is the updated file after
|
|
truncating names.
|
|
|
|
```text
|
|
# Default settings for user directories
|
|
#
|
|
# The values are relative pathnames from the home directory and
|
|
# will be translated on a per-path-element basis into the users locale
|
|
DESKTOP=gui
|
|
DOWNLOAD=dl
|
|
TEMPLATES=eg
|
|
PUBLICSHARE=pub
|
|
DOCUMENTS=docs
|
|
MEDIA=media
|
|
MUSIC=media/music
|
|
PICTURES=media/pics
|
|
VIDEOS=media/vids
|
|
# Another alternative is:
|
|
#MUSIC=Documents/Music
|
|
#PICTURES=Documents/Pictures
|
|
#VIDEOS=Documents/Videos
|
|
```
|
|
These are not all the directories, just the ones with XDG functionality. Some
|
|
of the may need to be downloaded.
|
|
|
|
## 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
|
|
|
|
|