brethil/dotfiles
1
0
Fork 0
mirror of https://git.decapod.one/brethil/dotfiles synced 2024-11-24 12:31:31 +01:00
Code Issues Releases Wiki Activity

docs: misc formatting fixes

Browse Source
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
1 changed files with 62 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

119
README.md
View File

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