Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/b-gran/config

Automatically installed dotfiles for MacOS [vim, tmux, bash]
https://github.com/b-gran/config

config dotfiles macos tmux

Last synced: 8 days ago
JSON representation

Automatically installed dotfiles for MacOS [vim, tmux, bash]

Awesome Lists containing this project

README

        

# `config`

My personal MacOS configuration and dotfiles. All of the config can be automatically installed by `install.sh`,
and the install script can be run repeatedly without issues.

Inspired by https://github.com/nicksp/dotfiles and https://github.com/kaicataldo/dotfiles.

## What's included
* `.bash_profile` with utilities in `.config/bash`
* [powerline](https://github.com/powerline/powerline) for `vim` and `bash`
* `vim` config with [Vundle](https://github.com/VundleVim/Vundle.vim)
* `tmux` config
* [solarized](http://ethanschoonover.com/solarized) color schemes for `vim`, `iTerm`, and `tmux`
* Useful CLI utils: `nvm`, `fpp`, `tree`
* `iTerm` config and fonts (config not automatically loaded)

## Prerequisites
* For now, only MacOS is supported
* `git` with submodule support
* Install [homebrew](https://brew.sh/)
* The install will abort if `brew` isn't on the `PATH`
* Install `vim`

## Installation

It doesn't matter where this config repository is on the filesystem. The installation process will handle symlinking everything into `$HOME`.

#### 1 - Clone the repository and run the install script

```
# Choose a location for the config. Then:
git clone https://github.com/b-gran/config.git
cd config
./install.sh
```

Any configuration files that would be overwritten are backed up automatically.
__It's safe to run the installation script multiple times.__

**Note:** if you want to skip the config backup, you can run
```sh
./install.sh -b
```

#### 2 - Configure `iTerm`

Open `iTerm` and navigate to `Preferences... > General > Preferences`. Tick the
`"Load preferences from a custom folder or URL"` checkbox. Then in the box to the right, enter or select the path to the `iTerm` config:
```
# Path to the iterm config folder within this repo
path/to/config/repo/.config/iterm/
```

## Making local changes to the config files

A local `.bash_profile` is loaded automatically from `$HOME/.local.bash_profile`.

The `$HOME/.vim` directory isn't modified, so you can safely modify it.