dotfiles

Here are my dotfiles, an attempt to make process of setting up new machine less painful.

Start here

Download this repo and follow the instruction below to start setting your environment. These instructions differ slightly for Linux and OSX, so choose the one below.

OSX

First things first: install Xcode:

sudo softwareupdate -i -a
xcode-select --install

Or just install Xcode from Apple store and

sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer/

HomeBrew

Next, run ./scripts/10_osx_homebrew.sh to download and install Homebrew and all the packages. ./scripts/11_osx_brew_casks.sh will install the casks.

Upgrade bash

Depending on the bash shipped with your system, it might be outdated. In order to update it, set a desired version of bash in ./scripts/20_osx_bash_update.sh and then just run the script. It's not really necessary, but some useful features (like auto-completion in vim), won't work on bash versions older than 4.

OSX defaults

./scripts/30_osx_defaults.sh sets some nice default settings. It also sets Terminal/iTerm colors to Solarized theme, printing full path in heading of Finder windows etc.

Ubuntu

APT packages

Running ./scripts/10_ubuntu_apt.sh will update APT and installs all packages listed in scripts/apt-packages.txt. Or you can always install the packages manually.

Git

After all packages were installed, it's a good idea to configure git.

P.S. on Ubuntu you might want to install a more recent version of git via PPA.

Add your credentials:

git config --global user.name "Your Name"
git config --global user.email "yourname@example.com"

Check if you have SSH installed:

ssh -V

Generate a new SSH key if you don't have one already:

ssh-keygen
# on Linux
cat ~/.ssh/id_rsa.pub | xclip -sel clip
# on Mac
cat ~/.ssh/id_rsa.pub | pbcopy

And now add it to the list of recognized keys.

Python

There are several ways to install Python:

Install with Miniconda or Anaconda.
Install using package managers. On Ubuntu using apt-get (see this example. The problem here is that usually it contains older version of Python, but you can try to install it with PPA (an example). On OSX you can easily install it with MacPorts. You can run ./scripts/40_osx_python.sh to install Python 2.7 and Python 3.6, it also sets python36 as default python and installs pip and PyQt5. P.S to check which Python version pip is using run pip -V.
Ubuntu: compile from source. Look here, here, and here, good luck! OSX: install from official Python's website

I decided to go with Miniconda installation for now, so ./scripts/40_ubuntu_python_conda.sh (or 40_osx_python.sh on OSX) will fetch and install python along with all pip packages (+ notebook extensions) from pip-packages.txt.

Vim

On Ubuntu, you can always find the latest(-ish) version of vim either through package manager or form official repo. Normally, just installing latest GUI vim will have all the features you need. You can install it with

sudo apt install vim-gui-common

It is done already in the ./scripts/10_ubuntu_apt.sh, no need to run it again.

Now that you have your Vim/MacVim successfully installed, we should install all of our precious plugins through ./scripts/51_vundle.sh. What it does, it installs Vundle and all plugins listed in ~/.vimrc. The script also installs pre-patched fonts for Powerline to work with vim-airline, you just have to specify the right font in your terminal/iTerm/MacVim etc. settings after installation.

Manual Vim install

In case you like suffering and want to compile it manually, here's what you ought to do. Run either ./scripts/50_osx_vim.sh or ./scripts/50_ubuntu_vim.sh based on your system. Don't forget to change Python's config dir to match your python. More info on how to compile vim from source on OSX can be found here, for Ubuntu check here and here.

On Ubuntu it's a good idea to use sudo checkinstall instead of sudo make install, then you can easily deinstall your vim with dpkg -r [compiled-vim] and don't forget to change package's name to something meaningfull when checkinstall asks you to.

P.S. when compiling vim with both python2 and python3, well they don't play nicely, so you'll probably have to choose either of them. Or google it.

Dotfiles

Next, we need to symlink all files in home directory. I have a custom script, which always links files but ask user for backup. There are several scenarios:

file already exist and is linked to a dotfile in your repository -> nothing happens.
file exists and it is identical to your dotfiles -> file is replaced with symlink, no backup.
file exist and differs from your dotfile -> file is symlinked to your dotfile, user is prompted to confirm backup.
file doesn't exist -> symbolic link is created.

The script is mostly based on Simon Eskildsen's linker.sh script, to which I added few modifications. Before linking files from you repository the scripts first checks dotfiles in your home ~/ directory for broken links and deletes them.

To link all dotfiles in your repository just type in:

./install.sh

Extras

Git status

I found this amazing python script called show_status. It will show git status of all git repositories under current dir. The script ./scripts/60_git_show_status.sh will download this script from its github repo and install it to /usr/local/bin/.

Terminal

OSX: iTerm and Terminal settings

extras/terminals contains different colors for Terminal/iTerm2, and a config file for iTerm.

Ubuntu: Tilix's config

In local dotfiles for Ubuntu you can find Iceberg color scheme for Tilix terminal emulator.

Tmux

Bash completion

There is a bash completion script in extras folder, you just need to copy it somewhere sane and source from bashrc, which is already done in this dotfiles, assuming you did the following:

sudo mkdir /opt/completions
sudo cp {extras,/opt/completions}/tmux.completion.bash

Tmux plugin manager

tpm (Tmux Plugin Manager) installs and loads tmux plugins. To install it just run

git clone https://github.com/tmux-plugins/tpm ~/.tmux/plugins/tpm

The rest is in home/.tmux.conf. To install a new plugin put it in the .tmux.conf, source it and press prefix + I.

Italics

Italics are not necessarily supported out-of-the-box in all terminals. To fix that go here, here, or here get enlightened and run

cd extras/
tic xterm-256color-italic.terminfo
killall tmux

You should now enjoy italics in your tmux+vim+iterm combo, as the rest of the config is in the dotfiles.

Menlo font

Normally, running ./scripts/51_vimplug.sh should install Menlo font patched for Powerline, if it wasn't just follow the steps described here.

Key Remap

I got used to Mac keyboard where ~ is located on the bottom row. So to remap it on Ubuntu > 16.04 I had to edit keys values in /usr/share/X11/xkb/symbols/. In order not to repeat this procedure again, just do the following:

sudo cp /usr/share/X11/xkb/symbols/us{,.backup}
sudo cp extras/keymap_us_ubuntu_2204 /usr/share/X11/xkb/symbols/us

This will only change symbols for English (Macintosh) keyboard, if you're using a different keyboard you should find the corresponding section in the us file and remap the <LSGT> symbol. The first line is to create a backup. If something does go wrong just run sudo cp /usr/share/X11/xkb/symbols/us{backup,}.

Warning

All this scripts worked fine for me, but might not work on your machine, so proceed with care. Never copy anything blindly, check what is inside and adjust to your workflow. Each script will exit as soon as any command in the scrip fails. If you want to see what is being executed, in the beginning of each script (around line 8) you should find the following:

set -e

change it to:

set -ex

Like that the script will output each command it's executing prepended with pluses.

mfedoten/dotfiles