From af32dd6bf33e6b0a696899426c610b90fcfc3c24 Mon Sep 17 00:00:00 2001 From: Ismo Vuorinen Date: Wed, 8 Mar 2023 09:24:36 +0200 Subject: [PATCH] Formatting, updated user config, tweaks --- README.md | 81 +++++++++++++++++--------------- config/astronvim/lua/user | 2 +- scripts/install-gh-extensions.sh | 1 + 3 files changed, 46 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index ec15a27..6831833 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # .dotfiles -Welcome to [ivuorinen](https://github.com/ivuorinen)'s .dotfiles repository. It's a hodgepodge of scripts -and configurations, tests and mistakes I'm not aware of yet. As I find more interesting tools, configs and -other stuff, this repository will live accordingly. +Welcome to [ivuorinen](https://github.com/ivuorinen)'s .dotfiles repository. +It's a hodgepodge of scripts and configurations, tests and mistakes I'm not +aware of yet. As I find more interesting tools, configs and other stuff, +this repository will live accordingly. Please for the love of everything good do not use these 1:1 as your own dotfiles, fork or download the repo as a zip and go from there with your own configs. @@ -16,27 +17,28 @@ fork or download the repo as a zip and go from there with your own configs. 3. ??? 4. Profit -Note: there's a bit chicken/egg situation, because settler assumes you don't have git, +Note: there's a bit chicken/egg situation, +because settler assumes you don't have git, and you need git to clone the repo. This will change soon™. ## Interesting files and locations -### Special folders +### Interesting folders -| Path | Description | -|--------------------|-------------------------------------------------------------------------------------| -| `.github` | GitHub Repository configuration files. Not part of the dotfiles per se. | -| `host-{hostname}/` | Host specific dotfiles. Configurations that should apply to that host only. | -| `local/bin` | Helper scripts that I've collected or wrote to make life easier. | -| `scripts` | Setup scripts. Some can be run many times, some are meant only for the first round. | +| Path | Description | +| ------------------ | --------------------------------------------------- | +| `.github` | GitHub Repository configuration files. | +| `host-{hostname}/` | Configurations that should apply to that host only. | +| `local/bin` | Helper scripts that I've collected or wrote. | +| `scripts` | Setup scripts. | ### dotfile folders -| Repo | Destination | Description | -|-----------|-------------|------------------------------------------------------------------| -| `config/` | `.config/` | Configurations for applications. | -| `local/` | `.local/` | XDG Base folder, contains `bin`, `share` and `state` for example | -| `ssh/` | `.ssh/` | SSH Configurations. | +| Repo | Destination | Description | +| --------- | ----------- | ------------------------------------------- | +| `config/` | `.config/` | Configurations for applications. | +| `local/` | `.local/` | XDG Base folder: `bin`, `share` and `state` | +| `ssh/` | `.ssh/` | SSH Configurations. | ### dfm - the dotfiles manager @@ -44,7 +46,8 @@ and you need git to clone the repo. This will change soon™. ### `scripts/install-dotfiles.sh` - dotfiles linker -The `scripts/install-dotfiles.sh` is a `rcm` generated shell script that does all the necessary linking. +The `scripts/install-dotfiles.sh` is a `rcm` generated shell script +that does all the necessary linking. To refresh the file, you can run `dfm dotfiles update` @@ -55,7 +58,7 @@ The folder structure follows [XDG Base Directory Specification][xdg] where possi ### XDG Variables | Var | Default | -|--------------------|----------------------| +| ------------------ | -------------------- | | Executables | `$HOME/.local/bin` | | `$XDG_DATA_HOME` | `$HOME/.local/share` | | `$XDG_STATE_HOME` | `$HOME/.local/state` | @@ -67,17 +70,24 @@ The folder structure follows [XDG Base Directory Specification][xdg] where possi - `$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`. +- `$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, …) -- 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 ':'. + - 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. +- `$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 @@ -85,12 +95,9 @@ The folder structure follows [XDG Base Directory Specification][xdg] where possi ### Interesting dotfiles repos -- https://dotfiles.github.io/inspiration/ -- https://github.com/frdmn/dotfiles - Ansible-based dotfile setup for macOS -- https://github.com/mvdan/dotfiles - Here be dragons -- https://github.com/vsouza/dotfiles - 🏡 My dotfiles -- https://github.com/freekmurze/dotfiles - My personal dotfiles - -### Interesting dotfiles tools - -- https://github.com/zero-sh/zero.sh - Radically simple personal bootstrapping tool for macOS. +- [https://dotfiles.github.io/inspiration/](dotfiles.github.io/inspiration) +- [https://github.com/frdmn/dotfiles](github.com/frdmn/dotfiles) - Ansible-based + dotfile setup for macOS +- [https://github.com/mvdan/dotfiles](mvdan/dotfiles) - Here be dragons +- [https://github.com/vsouza/dotfiles](vsouza/dotfiles) - 🏡 My dotfiles +- [https://github.com/freekmurze/dotfiles](freekmurze/dotfiles) - My personal dotfiles diff --git a/config/astronvim/lua/user b/config/astronvim/lua/user index 521d7db..890023c 160000 --- a/config/astronvim/lua/user +++ b/config/astronvim/lua/user @@ -1 +1 @@ -Subproject commit 521d7dbfa47a86e9bf865a9586123f16d42c914e +Subproject commit 890023c86c33fd65feb85745ffc562797acbc6dc diff --git a/scripts/install-gh-extensions.sh b/scripts/install-gh-extensions.sh index 43563b1..edf5976 100755 --- a/scripts/install-gh-extensions.sh +++ b/scripts/install-gh-extensions.sh @@ -1,6 +1,7 @@ #!/usr/bin/env bash # Install GitHub CLI extensions +# shellcheck source="shared.sh" source "$HOME/.dotfiles/scripts/shared.sh" if ! command -v gh &> /dev/null; then