diff --git a/.github/screenshots/tmux-nvim-astronvim.png b/.github/screenshots/tmux-nvim-astronvim.png new file mode 100644 index 0000000..49716bb Binary files /dev/null and b/.github/screenshots/tmux-nvim-astronvim.png differ diff --git a/.github/screenshots/tmux-starship.png b/.github/screenshots/tmux-starship.png new file mode 100644 index 0000000..674e6c7 Binary files /dev/null and b/.github/screenshots/tmux-starship.png differ diff --git a/README.md b/README.md index ab99b90..9f8b1e0 100644 --- a/README.md +++ b/README.md @@ -17,12 +17,26 @@ fork or download the repo as a zip and go from there with your own configs. 3. ??? 4. Profit +### Updates + +`cd $HOME/.dotfiles && git pull && ./install` + +## The looks + +## tmux with starship, the default view + +![screenshot of tmux with starship](./.github/screenshots/tmux-starship.png) + +## tmux + nvim (astronvim) editing this repository + +![screenshot of tmux showing nvim](.github/screenshots/tmux-nvim-astronvim.png) + ## Interesting files and locations ### Interesting folders | Path | Description | -| ------------------- | -------------------------------------------- | +|---------------------|----------------------------------------------| | `.github` | GitHub Repository configuration files. | | `hosts/{hostname}/` | Configs that should apply to that host only. | | `local/bin` | Helper scripts that I've collected or wrote. | @@ -31,7 +45,7 @@ fork or download the repo as a zip and go from there with your own configs. ### dotfile folders | Repo | Destination | Description | -| --------- | ----------- | ------------------------------------------- | +|-----------|-------------|---------------------------------------------| | `base/` | `.*` | `$HOME` level files. | | `config/` | `.config/` | Configurations for applications. | | `local/` | `.local/` | XDG Base folder: `bin`, `share` and `state` | @@ -47,32 +61,30 @@ The folder structure follows [XDG Base Directory Specification][xdg] where possi ### XDG Variables -| Var | Default | -| ------------------ | -------------------- | +| Env | Default | +|--------------------|----------------------| +| `$XDG_BIN_HOME` | `$HOME/.local/bin` | +| `$XDG_CONFIG_HOME` | `$HOME/.config` | | `$XDG_DATA_HOME` | `$HOME/.local/share` | | `$XDG_STATE_HOME` | `$HOME/.local/state` | -| `$XDG_CONFIG_HOME` | `$HOME/.config` | -| `$XDG_BIN_HOME` | `$HOME/.local/bin` | -- `$XDG_BIN_HOME` is a custom `env` for `.local/bin` folder. +- `$XDG_BIN_HOME` defines directory that contains local binaries. - `$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. + 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: - - actions history (logs, history, recently used files, …) - - current state of the application that can be reused - on a restart (view, layout, open files, undo history, …) + - 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: + - actions history (logs, history, recently used files, …) + - current state of the application that can be reused + on a restart (view, layout, open files, undo history, …) - 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. @@ -81,14 +93,3 @@ The folder structure follows [XDG Base Directory Specification][xdg] where possi The directories in `$XDG_DATA_DIRS` should be seperated with a colon ':'. [xdg]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html - -## Interesting links - -### Interesting dotfiles repos - -- [dotfiles.github.io/inspiration/](https://dotfiles.github.io/inspiration) -- [frdmn/dotfiles](https://github.com/github.com/frdmn/dotfiles) - Ansible-based - dotfile setup for macOS -- [mvdan/dotfiles](https://github.com/mvdan/dotfiles) - Here be dragons -- [vsouza/dotfiles](https://github.com/vsouza/dotfiles) - 🏡 My dotfiles -- [freekmurze/dotfiles](https://github.com/freekmurze/dotfiles) - My personal dotfiles