chore(docs): Update README and add screenshots

This commit is contained in:
2023-06-08 14:28:52 +03:00
parent 52cbebc0b3
commit 2b06642e4b
3 changed files with 34 additions and 33 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 140 KiB

BIN
.github/screenshots/tmux-starship.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

View File

@@ -17,12 +17,26 @@ fork or download the repo as a zip and go from there with your own configs.
3. ??? 3. ???
4. Profit 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 files and locations
### Interesting folders ### Interesting folders
| Path | Description | | Path | Description |
| ------------------- | -------------------------------------------- | |---------------------|----------------------------------------------|
| `.github` | GitHub Repository configuration files. | | `.github` | GitHub Repository configuration files. |
| `hosts/{hostname}/` | Configs that should apply to that host only. | | `hosts/{hostname}/` | Configs that should apply to that host only. |
| `local/bin` | Helper scripts that I've collected or wrote. | | `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 ### dotfile folders
| Repo | Destination | Description | | Repo | Destination | Description |
| --------- | ----------- | ------------------------------------------- | |-----------|-------------|---------------------------------------------|
| `base/` | `.*` | `$HOME` level files. | | `base/` | `.*` | `$HOME` level files. |
| `config/` | `.config/` | Configurations for applications. | | `config/` | `.config/` | Configurations for applications. |
| `local/` | `.local/` | XDG Base folder: `bin`, `share` and `state` | | `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 ### XDG Variables
| Var | Default | | Env | Default |
| ------------------ | -------------------- | |--------------------|----------------------|
| `$XDG_BIN_HOME` | `$HOME/.local/bin` |
| `$XDG_CONFIG_HOME` | `$HOME/.config` |
| `$XDG_DATA_HOME` | `$HOME/.local/share` | | `$XDG_DATA_HOME` | `$HOME/.local/share` |
| `$XDG_STATE_HOME` | `$HOME/.local/state` | | `$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 - `$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, files should be stored.
a default equal to `$HOME/.local/share` should be used. - If `$XDG_DATA_HOME` is either not set or empty, a default equal to
- `$XDG_CONFIG_HOME` defines the base directory relative to which user-specific configuration `$HOME/.local/share` should be used.
files should be stored. If `$XDG_CONFIG_HOME` is either not set or empty, - `$XDG_CONFIG_HOME` defines the base directory relative to which user-specific
a default equal to `$HOME/.config` should be used. 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 - `$XDG_STATE_HOME` defines the base directory relative
to which user-specific state files should be stored. to which user-specific state files should be stored.
If `$XDG_STATE_HOME` is either not set or empty, a default - If `$XDG_STATE_HOME` is either not set or empty, a default equal to `$HOME/.local/state` should be used.
equal to `$HOME/.local/state` should be used. - The `$XDG_STATE_HOME` contains state data that should persist between (application) restarts,
- The `$XDG_STATE_HOME` contains state data that should persist but that is not important or portable enough to the user that it should be stored in `$XDG_DATA_HOME`.
between (application) restarts, - It may contain:
but that is not important or portable enough to the user that - actions history (logs, history, recently used files, …)
it should be stored in `$XDG_DATA_HOME`. - current state of the application that can be reused
It may contain: on a restart (view, layout, open files, undo history, …)
- 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`. - User-specific executable files may be stored in `$HOME/.local/bin`.
Distributions should ensure this directory shows up in the UNIX `$PATH` Distributions should ensure this directory shows up in the UNIX `$PATH`
environment variable, at an appropriate place. 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 ':'. The directories in `$XDG_DATA_DIRS` should be seperated with a colon ':'.
[xdg]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html [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