dotfiles/README.md

75 lines
2.7 KiB
Markdown
Raw Normal View History

2016-04-18 11:42:43 +02:00
# dotfiles
These are my dotfiles. They are awesome.
This repo contains my dotfiles which I use at OS X and FreeBSD systems. This set features a nice and fast zsh config, a neat vim environment and a tmux config.
2020-05-01 00:03:43 +02:00
![Image](https://git.debilux.org/chbaer/dotfiles/raw/branch/master/screenshot.png)
2016-04-18 11:42:43 +02:00
The zsh prompt is handcrafted to look neat and give some extra info. When you are root the user- and hostname color changes from blue to red. If you are connected via ssh, the prompt will show some green arrows behind the working path and when you are in a git repository, it will show some git infos at the right side.
The tmux config contains some nice settings to make my work a bit easier and look nice.
2020-07-02 15:30:08 +02:00
My color scheme is the awesome [Nord Color scheme](https://www.nordtheme.com) by Arctic Ice Studio and my font is [~~FiraCode~~](https://github.com/tonsky/FiraCode) [Source Code Pro](https://adobe-fonts.github.io/source-code-pro/).
2016-04-18 11:42:43 +02:00
2020-07-04 22:28:28 +02:00
The repo ships with a bootstrap script that you can use to deploy and update the dotfiles.
2016-04-18 11:42:43 +02:00
# bootstrap.sh help
2020-05-09 00:46:54 +02:00
Usage: bootstrap.sh command {params}
2020-05-09 00:46:54 +02:00
list List all files that will be copied
update Update the git repo and the included submodules
deploy Copy the files to ~
install Update and deploy these dotfiles
help Show this screen
The dotfiles will be copied to your **~**.
2016-04-18 11:42:43 +02:00
2020-07-04 22:28:28 +02:00
## ZSH with bells and whistles
The ZSH config doesnt use any frameworks and is tuned for speed.
The config delivers some nice extra functions.
### extract()
_extract_ can be run with _extract <filename>_ to extract archives in any given formats.
### tmix()
_tmix_ creates a new tmux session and connects to a given list of servers with mosh and attaches to a tmux session at the server.
You must define a space separated list of servers as _$TMIX_SERVERS=“<SERVERS>”_ e.g. in _~/.zsh/lib/30-extras.zsh_.
You can define a name for the used session in _$TMIX_SESSION=“<SESSION>”_. Otherwise it will use „TMIX“.
_tmix kill_ kills the session.
## tmux config
The tmux config rebinds the prefix key to C-a. It features different shortcuts to make my life easier (e.g. "C-a -„ for splitting the window horizontally.)
It also supports nested sessions with a modified color scheme. Thats nice when using tmix.
![Image](https://git.debilux.org/chbaer/dotfiles/raw/branch/master/screenshot-tmix.png)
2020-05-02 20:57:54 +02:00
## Installation
2016-04-18 11:42:43 +02:00
1. Get the dotfiles.
2020-05-01 00:03:43 +02:00
git clone https://git.debilux.org/chbaer/dotfiles.git
2016-04-18 11:42:43 +02:00
2. Deploy
2020-05-02 20:57:54 +02:00
./bootstrap.sh install
2016-04-18 11:42:43 +02:00
3. Enjoy!
If you want to update to the newest version, run ``bootstrap.sh update`` from within the dotfiles folder and ``bootstrap.sh deploy`` to copy the updated files.
2016-04-18 11:42:43 +02:00
## Credits
2020-05-02 20:57:54 +02:00
- [Git prompt by Josh Dick](https://gist.github.com/joshdick/4415470)