1
0
mirror of https://git.decapod.one/brethil/dotfiles synced 2024-12-26 01:01:32 +01:00

docs: misc formatting fixes

This commit is contained in:
bretello 2020-12-09 04:00:34 +01:00
parent d066906af3
commit 6bd0ce46ba
Signed by: brethil
GPG Key ID: 876AAC6290170FE7

125
README.md
View File

@ -4,75 +4,75 @@ A set of zsh dotfiles based on antibody and oh-my-zsh
## Description
├── README.md
├──────── Main files ────────
│ ├── aliases.sh
│ │     └── aliases definitions (sources `~/.dotfiles_aliases`)
│ ├── colors.sh
│ │     └── ANSI color escapes
│ ├── functions.sh
│ │     └── contains function definitions (sources `~/.dotfiles_functions`)
│ ├── ansible
│ │     └── ansible playboooks/config
│ └── brethil_dotfile.sh:
      └── This file should be sourced by your `.zshrc`
├──────── antibody plugins ────────
│ ├── antibody_plugins_arch.txt
│ └── antibody_plugins.txt
├──────── oh-my-zsh themes ────────
│ ├── brethil.zsh-theme
│ └── brethil-minimal.zsh-theme
├──────── Misc rc files────────
│ ├── gitconfig
│ │     └── git configuration
│ ├── ackrc
│ │     └── `ack`'s rc: a grep-like text finder
│ ├── ipython
│ │     ├── profile_default
│ │     ├── ipython_config.py
│ │     ├── startup
│ │     ├── 11-autoreload.py
│ │     └── README
│ ├── vim
│ │    ├── vimrc
│ │    │ └── main vim rc
│ │    ├── plugs.vim
│ │    │ └── plugins to be installed with vim-plug
│ │    ├── plugins_config.vim
│ │    │ └── plugins configuration
│ │    ├── shortcuts.vim
│ │    │ └── vim shortcuts definitions
│ │    ├── functions.vim
│ │    │ └── miscellaneous vim function
│ │    └── twilight256.vim
│ │      └── an old colorscheme
│ └── pdbrc.py
     └── pdb++'s rc (a drop-in replacement for pdb)
├──────── Other ─────────────
├── check_for_update.sh
     └── selfupdate script
└── useful_commands
├── README.md
├──────── Main files ────────
│ ├── aliases.sh
│ │     └── aliases definitions (sources `~/.dotfiles_aliases`)
│ ├── colors.sh
│ │     └── ANSI color escapes
│ ├── functions.sh
│ │     └── contains function definitions (sources `~/.dotfiles_functions`)
│ ├── ansible
│ │     └── ansible playboooks/config
│ └── brethil_dotfile.sh:
      └── This file should be sourced by your `.zshrc`
├──────── antibody plugins ────────
│ ├── antibody_plugins_arch.txt
│ └── antibody_plugins.txt
├──────── oh-my-zsh themes ────────
│ ├── brethil.zsh-theme
│ └── brethil-minimal.zsh-theme
├──────── Misc rc files────────
│ ├── gitconfig
│ │     └── git configuration
│ ├── ackrc
│ │     └── ack rc: a grep-like text finder
│ ├── ipython
│ │     ├── profile_default
│ │     ├── ipython_config.py
│ │     ├── startup
│ │     ├── 11-autoreload.py
│ │     └── README
│ ├── vim
│ │    ├── vimrc
│ │    │ └── main vim rc
│ │    ├── plugs.vim
│ │    │ └── plugins to be installed with vim-plug
│ │    ├── plugins_config.vim
│ │    │ └── plugins configuration
│ │    ├── shortcuts.vim
│ │    │ └── vim shortcuts definitions
│ │    ├── functions.vim
│ │    │ └── miscellaneous vim function
│ │    └── twilight256.vim
│ │      └── an old colorscheme
│ └── pdbrc.py
     └── pdb++ rc (a drop-in replacement for pdb)
├──────── Other ─────────────
├── check_for_update.sh
     └── selfupdate script
└── useful_commands
## Installation
With ansible:
- With ansible:
```bash
[ bash dev/add_community.general.sh ] # if community.general is not installed
ansible-playbook -v -i <hosts file> [-e fix_annoyances=true] ansible/playbooks/setup.yml
```
```bash
bash dev/add_community.general.sh # only if community.general is not installed
ansible-playbook -v -i <hosts file> ansible/playbooks/setup.yml
```
[use this with a docker container](dev/README.md)
This playbook can be tested [with a docker container](dev/README.md)
Use `-e fix_annoyances=true` to fix some small annoyances (only run once)
Use `-e fix_annoyances=true` to fix some small annoyances (only run once)
Manually (this only installs the zsh configuration):
- Manually (this only installs the zsh configuration):
```bash
git clone https://git.decapod.one/brethil/dotfiles ~/.dotfiles
echo 'DOTFILES=~/.dotfiles' >> ~/.zshrc
echo 'source $DOTFILES/brethil_dotfile.sh'
```
```bash
git clone https://git.decapod.one/brethil/dotfiles ~/.dotfiles
echo 'DOTFILES=~/.dotfiles' >> ~/.zshrc
echo 'source $DOTFILES/brethil_dotfile.sh'
```
A self-update mechanism is included. It asks for confirmation to pull the latest changes
from the git repo every two weeks. This also updates the git-sourced repositories installed
@ -119,8 +119,7 @@ in your `.zshrc`. This requires antibody installed.
- (Optional: Compression, this should allow more responsive shells with slow connections,
but will slow things down when copying large files. My suggestion is to have compression enabled
on a by-host basis in `~/.ssh/config`)
3. `brethil.zsh-theme`, `brethil-minimal.zsh-themes`, themes for oh-my-zsh,
symlinked in `$ZSH/custom/themes` (`$ZSH=~/.oh-my-zsh`)
3. `brethil.zsh-theme`, `brethil-minimal.zsh-themes`, themes for oh-my-zsh.
4. `~/.dotfiles_functions`, `~/.dotfiles_aliases` are sourced by this dotfiles, allowing for custom functions/aliases
5. useful_commands contains a list of useful commands (the first rule of the tautology club...)