docs: misc formatting fixes

feature/symbol-search
bretello 2020-12-09 04:00:34 +01:00
parent d066906af3
commit 6bd0ce46ba
Signed by: brethil
GPG Key ID: 876AAC6290170FE7
1 changed files with 62 additions and 63 deletions

View File

@ -26,7 +26,7 @@ A set of zsh dotfiles based on antibody and oh-my-zsh
│ ├── gitconfig
│ │     └── git configuration
│ ├── ackrc
│ │     └── `ack`'s rc: a grep-like text finder
│ │     └── ack rc: a grep-like text finder
│ ├── ipython
│ │     ├── profile_default
│ │     ├── ipython_config.py
@ -47,7 +47,7 @@ A set of zsh dotfiles based on antibody and oh-my-zsh
│ │    └── twilight256.vim
│ │      └── an old colorscheme
│ └── pdbrc.py
     └── pdb++'s rc (a drop-in replacement for pdb)
     └── pdb++ rc (a drop-in replacement for pdb)
├──────── Other ─────────────
├── check_for_update.sh
     └── selfupdate script
@ -55,18 +55,18 @@ A set of zsh dotfiles based on antibody and oh-my-zsh
## 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 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)
Manually (this only installs the zsh configuration):
- Manually (this only installs the zsh configuration):
```bash
git clone https://git.decapod.one/brethil/dotfiles ~/.dotfiles
@ -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...)