Skip to content

Commit 2de999a

Browse files
readme: update overview and install
1 parent 7327342 commit 2de999a

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
# Configuration files for common tools
22

3-
Configuration files for tools such as Git, Clojure development tools.
3+
Configuration files for command line, desktop and software development tools:
44

5-
* git - multiple identities select on path, command aliases, clone short-cuts, SSH signing & allowed signatures, inclusive ignore patterns and common configuration options
6-
* aws - config with profiles and single sign-on with okta
7-
* regolith2 - 13 tiling manager on Ubuntu linux distribution (tweaks)
8-
* clojure - [cljstyle](https://github.com/greglook/cljstyle) formatting rules
5+
* Debian Linux - post install, TUI & dev tool scripts
6+
* Git client - multiple identities select on path, command aliases, clone short-cuts, SSH signing & allowed signatures
97
* [kitty terminal](https://sw.kovidgoyal.net/kitty/) configuration - font, symbol mappings for nerdfonts, light and dark terminal colorschemes
108
* `shell-aliases` common aliases used by all shells (bash, zsh)
119
* [Starship](https://starship.rs/) cross-shell prompt config with a customised [Catppuccin Powerline theme](https://starship.rs/presets/catppuccin-powerline)
10+
* Zsh - Practicalli configuration based on [Prezto community config](https://github.com/sorin-ionescu/prezto)
11+
* aws - config with profiles and single sign-on with okta
12+
* regolith-desktop - i3 tiling manager on Ubuntu linux distribution (tweaks)
13+
* clojure - [cljstyle](https://github.com/greglook/cljstyle) formatting rules
1214

1315

1416
## Install
1517

16-
Practicalli follows the FreeDesktop.org XDG basedir specification for configuration files, with `$XDG_CONFIG_HOME` set to `$HOME/.config`. Using this directory simplifies the versioning of configuration files, compared to using the root of a user account, i.e. `$HOME`.
18+
Clone this project.
1719

18-
> Learn more about [configuring the FreeDesktop.org XDG basedir standard for development tools](https://practical.li/blog/posts/adopt-FreeDesktop.org-XDG-standard-for-configuration-files/)
20+
Create symbolic links in the `~/.config/` directory for each file or directory you wish to use. Or copy useful parts into your own configuration files.
1921

20-
Clone this repository to `$XDG_CONFIG_HOME` to use the configuration straight away.
22+
The [install-configs.sh](https://github.com/practicalli/dotfiles/blob/main/debian-linux/practicalli/install-configs.sh) bash script in the [Practicalli dotfiles repository](https://github.com/practicalli/dotfiles/tree/main/debian-linux) to download the Practicalli dotfiles repository and link Practicalli configs in `~/.config/`.
2123

22-
```shell
23-
git clone https://github.com/practicalli/dotfiles.git $XDG_CONFIG_HOME
24-
```
24+
Practicalli follows the FreeDesktop.org XDG basedir specification for configuration files, with `$XDG_CONFIG_HOME` set to `$HOME/.config`.
2525

26-
Or clone the repository to a project directory and add operating system symlinks from the `$XDG_CONFIG_HOME`, `$HOME/.config` or `$HOME`.
26+
> NOTE: Using `$HOME/.config` simplifies versioning of configuration files compared to using the root of a user account, i.e. `$HOME`.
2727
28-
To use this configuration as a base for your own repository, fork this repository and copy the configuration directories or specific examples as required.
28+
> Learn more about [configuring the FreeDesktop.org XDG basedir standard for development tools](https://practical.li/blog/posts/adopt-FreeDesktop.org-XDG-standard-for-configuration-files/)
2929
3030

31-
## Specific tool repositories
31+
## Other tool configurations
3232

3333
Tools with a larger configuration have been separated into their own repositories for convenience.
3434

0 commit comments

Comments
 (0)