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

https://github.com/remarkablemark/dotfiles

@remarkablemark's dotfiles
https://github.com/remarkablemark/dotfiles

brew dotfiles macos tmux vim zsh

Last synced: 2 months ago
JSON representation

@remarkablemark's dotfiles

Awesome Lists containing this project

README

        

# dotfiles

[remarkablemark's](https://b.remarkabl.org/github) [dotfiles](https://dotfiles.github.io/).

Table of Contents

- [Prerequisites](#prerequisites)
- [Install](#install)
- [Shell](#shell)
- [Vim](#vim)
- [iTerm2](#iterm2)
- [Software](#software)
- [Directory Structure](#directory-structure)
- [License](#license)

## Prerequisites

> [!NOTE]
> My dotfiles are only compatible with macOS.

If you have SSH access to the repository, then [set up your SSH key](https://remarkablemark.org/blog/2020/04/13/avoid-ssh-passphrase/) and clone the repository:

```sh
git clone [email protected]:remarkablemark/dotfiles.git ~/dotfiles
cd ~/dotfiles
```

Otherwise, clone the repository:

```sh
git clone https://github.com/remarkablemark/dotfiles.git ~/dotfiles
cd ~/dotfiles
```

## Install

Run [install](https://github.com/remarkablemark/dotfiles/blob/master/install.sh):

```sh
./install.sh
```

If [Vundle](https://github.com/VundleVim/Vundle.vim) isn't installed, you can install it manually:

```sh
git clone https://github.com/VundleVim/Vundle.vim.git ~/dotfiles/bundle/Vundle.vim
vim +PluginInstall +qall
```

If [YouCompleteMe](https://github.com/ycm-core/YouCompleteMe) isn't compiled, you can compile it manually:

```sh
python3 bundle/YouCompleteMe/install.py --all
```

## Shell

Verify the shell is `zsh`:

```sh
echo $SHELL
```

Reload the shell:

```sh
source ~/.zshrc
```

Or restart the shell:

```sh
exec -l $SHELL
```

## Vim

Reload vimrc in Vim:

```sh
vim ~/.vim/vimrc
```

```vim
:source %
```

## iTerm2

Download [iTerm2](https://iterm2.com/):

```sh
brew install --cask iterm2
```

Load preferences: **iTerm2** > **Preferences** > **General** > **Preferences** > **Load preferences from a custom folder or URL**: `~/dotfiles/`

Update profile: **iTerm2** > **Preferences** > **Profiles** > **Colors and Text**

Open tab in same directory: **iTerm2** > **Preferences** > **Profiles** > **Working Directory** > **Reuse previous session's directory**

## Software

- [f.lux](https://justgetflux.com/)
- [Rectangle](https://rectangleapp.com/)

## Directory Structure

```sh
tree -I bundle
```

```
.
├── LICENSE
├── README.md
├── after
│   └── ftplugin
│   └── php.vim
├── com.googlecode.iterm2.plist
├── gitignore
├── install.sh
├── powerline.tmux
├── tmux.conf
├── vimrc
└── zshrc

3 directories, 10 files
```

## License

[MIT](LICENSE)