ivuorinen/dotfiles
1
0
Fork 0
mirror of https://github.com/ivuorinen/dotfiles.git synced 2026-02-04 10:49:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated README.md

Browse Source
This commit is contained in:
Ismo Vuorinen
2022-12-14 14:16:23 +02:00
committed by GitHub
parent 3acc948c23
commit 1d1a95fad2
1 changed files with 11 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@@ -4,36 +4,22 @@ The folder structure follows [XDG Base Directory Specification][xdg] where possi
## Setup
## rcrc
### First time setup
Update install script
1. Clone this repository to `$HOME/.dotfiles`
2. `bash $HOME/.dotfiles/scripts/settler.sh`
3. ???
4. Profit
```bash
rcup -B 0 -g > ~/.dotfiles/install.sh | shfmt -w -l ~/.dotfiles/install.sh
```
Note: there's a bit chicken/egg situation, because settler assumes you don't have git, and you need git to clone the repo.
## brew
### dfm - the dotfiles manager
Install everything described in `Brewfile`
`dfm` is a shellscript that has some tools that help with dotfiles management.
```bash
brew bundle install --force --file=~/.dotfiles/Brewfile
```
## Configuration
Update `Brewfile`
```bash
brew bundle dump --force --file=~/.dotfiles/Brewfile --describe
```
Enable automatic brew updates and upgrades.
```bash
brew autoupdate start 43200 --upgrade --cleanup --immediate
```
## XDG Variables
### XDG Variables
| Var | Default |
|--------------------|----------------------|
@@ -42,8 +28,7 @@ brew autoupdate start 43200 --upgrade --cleanup --immediate
| `$XDG_STATE_HOME` | `$HOME/.local/state` |
| `$XDG_CONFIG_HOME` | `$HOME/.config` |
- `$XDG_DATA_HOME` defines the base directory relative to which user-specific data files should be stored. If `$XDG_DATA_HOME` is either not set or empty, a default equal to ` $HOME/.local/share` should be used.
- `$XDG_DATA_HOME` defines the base directory relative to which user-specific data files should be stored. If `$XDG_DATA_HOME` is either not set or empty, a default equal to `$HOME/.local/share` should be used.
- `$XDG_CONFIG_HOME` defines the base directory relative to which user-specific configuration files should be stored. If `$XDG_CONFIG_HOME` is either not set or empty, a default equal to `$HOME/.config` should be used.
- `$XDG_STATE_HOME` defines the base directory relative to which user-specific state files should be stored. If `$XDG_STATE_HOME` is either not set or empty, a default equal to `$HOME/.local/state` should be used.
- The `$XDG_STATE_HOME` contains state data that should persist between (application) restarts, but that is not important or portable enough to the user that it should be stored in `$XDG_DATA_HOME`. It may contain:
@@ -52,5 +37,4 @@ brew autoupdate start 43200 --upgrade --cleanup --immediate
- User-specific executable files may be stored in `$HOME/.local/bin`. Distributions should ensure this directory shows up in the UNIX `$PATH` environment variable, at an appropriate place.
- `$XDG_DATA_DIRS` defines the preference-ordered set of base directories to search for data files in addition to the `$XDG_DATA_HOME` base directory. The directories in `$XDG_DATA_DIRS` should be seperated with a colon ':'.
[xdg]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html