Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/yous/dotfiles

/home/yous
https://github.com/yous/dotfiles
bashrc config dotfiles gitconfig gitignore tmux-configs vimrc zshrc
Last synced: about 1 month ago
JSON representation
/home/yous
Host: GitHub
URL: https://github.com/yous/dotfiles
Owner: yous
License: mit
Created: 2014-04-28T18:54:11.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2024-07-15T04:18:14.000Z (6 months ago)
Last Synced: 2024-07-15T05:31:34.052Z (6 months ago)
Topics: bashrc, config, dotfiles, gitconfig, gitignore, tmux-configs, vimrc, zshrc
Language: Shell
Homepage:
Size: 2.45 MB
Stars: 43
Watchers: 9
Forks: 10
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project

README

        # dotfiles

[![Build Status](https://github.com/yous/dotfiles/workflows/CI/badge.svg?branch=master)](https://github.com/yous/dotfiles/actions?query=branch%3Amaster)

[@yous](https://github.com/yous)' dotfiles.

## Table of Contents

- [Requirements](#requirements)

- [Installation](#installation)

  - [Git](#git)

  - [Homebrew](#homebrew)

  - [Version Manager](#version-manager)

  - [Ruby](#ruby)

  - [Rust](#rust)

  - [Python](#python)

  - [Node.js](#node-js)

  - [Zsh](#zsh)

  - [Vim](#vim)

  - [Neovim](#neovim)

  - [WeeChat](#weechat)

  - [Tools](#tools)

  - [IntelliJ, Android Studio](#intellij-android-studio)

  - [iTerm2](#iterm2)

- [License](#license)

## Requirements

- [Git](https://git-scm.com)

## Installation

Clone this repository:

``` sh

git clone https://github.com/yous/dotfiles.git

cd dotfiles

```

For available install options:

``` sh

./install.sh

```

| Command option | Description                              |

|----------------|------------------------------------------|

| `link`         | Install symbolic links                   |

| `asdf`         | Install asdf                             |

| `brew`         | Install Homebrew on macOS (or Linux)     |

| `chruby`       | Install chruby                           |

| `formulae`     | Install Homebrew formulae using Brewfile |

| `mise`         | Install mise                             |

| `n`            | Install n                                |

| `pwndbg`       | Install pwndbg                           |

| `pyenv`        | Install pyenv with pyenv-virtualenv      |

| `rbenv`        | Install rbenv                            |

| `ruby-install` | Install ruby-install                     |

| `rustup`       | Install rustup                           |

| `rvm`          | Install RVM                              |

| `weechat`      | Install WeeChat configuration            |

In Windows, use `install.bat`. It links files into the user's home directory.

### Git

Set user-specific configurations on `~/.gitconfig.user`:

``` gitconfig

[user]

	name = Your Name

	email = [email protected]

```

If you are using a public PGP key:

``` gitconfig

[user]

	signingkey = YOUR KEY

```

You can also sign your each commit automatically:

``` gitconfig

[commit]

	gpgsign = true

```

For more information about signing commits, see

[A Git Horror Story: Repository Integrity With Signed Commits](https://mikegerwitz.com/2012/05/a-git-horror-story-repository-integrity-with-signed-commits).

If you want to use Gmail for `git send-email`,

``` gitconfig

[sendemail]

	smtpEncryption = tls

	smtpServer = smtp.gmail.com

	smtpServerPort = 587

	smtpUser = [email protected]

```

For more information, see [the documentation](https://git-scm.com/docs/git-send-email)

for git-send-email.

Set local-specific configurations on `~/.gitconfig.local`:

``` gitconfig

[merge]

	conflictStyle = zdiff3

[includeIf "gitdir:~/to/group/"]

	path = /path/to/foo.inc

```

For more information, see [conditional includes](https://git-scm.com/docs/git-config#_conditional_includes)

section in the git-config documentation.

If you want to use latest release of Git for Ubuntu:

``` sh

sudo add-apt-repository ppa:git-core/ppa

sudo apt-get update

```

Visit [the PPA of Git for Ubuntu](https://launchpad.net/~git-core/+archive/ubuntu/ppa)

for more information.

### Homebrew

If you want to install [Homebrew](https://brew.sh) or [Homebrew on Linux](https://docs.brew.sh/Homebrew-on-Linux),

``` sh

./install.sh brew

```

Then install Homebrew formulae with:

``` sh

./install.sh formulae

```

On macOS prior to Mojave, install Rust using rustup, and then install several

utilities using `cargo`:

``` sh

cargo install bat bottom fd-find ripgrep

```

### Version Manager

#### asdf

If you want to install [asdf](https://asdf-vm.com/),

``` sh

./install.sh asdf

```

Then install Node.js, Python, Ruby with:

``` sh

asdf plugin add nodejs

asdf install nodejs latest:"$(asdf nodejs resolve lts)"

asdf plugin add python

asdf install python latest

asdf plugin add ruby

asdf install ruby latest

```

Then set global defaults:

``` sh

asdf global nodejs latest:"$(asdf nodejs resolve lts)"

asdf global python latest

asdf global ruby latest

```

#### mise

If you want to install [mise](https://github.com/jdx/mise),

``` sh

./install.sh mise

```

Then install Node.js, Python, Ruby with:

``` sh

mise install node@lts

mise install python

mise install ruby

```

Then set global defaults:

``` sh

mise use --global node@lts

mise use --global python@latest

mise use --global ruby@latest

```

### Ruby

#### chruby

If you want to install [chruby](https://github.com/postmodern/chruby), if you're

on macOS,

``` sh

brew install ruby-install

brew install chruby

```

Otherwise, install [ruby-install](https://github.com/postmodern/ruby-install)

first, if you're on Arch Linux,

``` sh

yaourt -S ruby-install

```

Otherwise,

``` sh

./install.sh ruby-install

```

Then install chruby,

``` sh

./install.sh chruby

```

#### RVM

If you want to install [RVM](https://rvm.io),

``` sh

./install.sh rvm

```

Update RVM with:

``` sh

rvm get stable

```

#### rbenv

If you want to install [rbenv](https://github.com/rbenv/rbenv),

``` sh

./install.sh rbenv

```

### Rust

If you want to install [rustup](https://rustup.rs),

``` sh

./install.sh rustup

```

### Python

If you want to install [pyenv](https://github.com/pyenv/pyenv) and

[pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv),

``` sh

./install.sh pyenv

```

### Node.js

If you want to install [n](https://github.com/tj/n),

``` sh

./install.sh n

```

Then install Node.js with:

``` sh

n lts

```

### Zsh

To use [Zsh](https://www.zsh.org) as default shell,

``` sh

chsh -s /bin/zsh

```

If you use custom Zsh like compiled one by [Homebrew](https://brew.sh), add

`/usr/local/bin/zsh` to `/etc/shells` and

``` sh

chsh -s /usr/local/bin/zsh

```

To update Zsh plugins:

``` sh

zinit update --all

```

To update [Zinit](https://github.com/zdharma-continuum/zinit) itself:

``` sh

zinit self-update

```

To make RVM works with Vim on OS X Yosemite or earlier, move `/etc/zshenv` to

`/etc/zshrc` as [Tim Pope mentioned](https://github.com/tpope/vim-rvm#faq).

``` sh

sudo mv /etc/zshenv /etc/zshrc

```

### Vim

To install [Vim](https://www.vim.org) plugins,

```

:PlugInstall

```

You should install [Exuberant Ctags](https://ctags.sourceforge.net/) to use

[vim-gutentags](https://github.com/ludovicchabant/vim-gutentags). You should

install Node.js to use [coc.nvim](https://github.com/neoclide/coc.nvim).

To update Vim plugins:

```

:PlugUpdate

```

To update [vim-plug](https://github.com/junegunn/vim-plug):

```

:PlugUpgrade

```

For additional syntax checkers for coc.nvim, [ALE](https://github.com/dense-analysis/ale),

or [Syntastic](https://github.com/vim-syntastic/syntastic):

- C, C++

  - clang-check: `brew install llvm`

  - clang-tidy: `brew install llvm`

  - cppcheck: `brew install cppcheck`

- CSS

  - stylelint: `npm install -g stylelint stylelint-config-standard`

- JavaScript

  - ESLint: `npm install -g eslint`

- JSON

  - JSONLint: `npm install -g jsonlint`

- Python

  - flake8: `pip install flake8`

  - jedi: `pip install jedi`

- Ruby

  - RuboCop: `gem install rubocop`

  - Solargraph: `gem install solargraph`

- SASS, SCSS

  - stylelint: `npm install -g stylelint stylelint-config-sass-guidelines`

### Neovim

To use Python 2 or 3 via pyenv in [Neovim](https://neovim.io),

``` sh

pyenv install 2.7.18

pyenv virtualenv 2.7.18 neovim2

pyenv activate neovim2

pip install pynvim

pyenv install 3.8.2

pyenv virtualenv 3.8.2 neovim3

pyenv activate neovim3

pip install pynvim

```

To use Ruby in Neovim,

``` sh

gem install neovim

```

To use Node.js in Neovim,

``` sh

npm install -g neovim

```

### WeeChat

To install [WeeChat](https://weechat.org) configuration,

``` sh

./install.sh weechat

```

Then install scripts:

```

/script install autosort.py buffers.pl colorize_nicks.py iset.pl

```

To update WeeChat scripts:

```

/script update

/script upgrade

```

### Tools

#### pwndbg

If you want to install [pwndbg](https://github.com/pwndbg/pwndbg),

``` sh

./install.sh pwndbg

```

### IntelliJ, Android Studio

To use Tomorrow Theme:

1. Download `JetBrains/settings.jar` from [chriskempson/tomorrow-theme](https://github.com/chriskempson/tomorrow-theme).

2. Open File > Import Settings… in [IntelliJ](https://www.jetbrains.com/idea/) or

   [Android Studio](https://developer.android.com/studio).

3. Select downloaded `settings.jar`.

4. Open Settings > Editor > Colors Scheme.

5. Select one of Tomorrow Theme.

### iTerm2

To use Tomorrow Theme:

1. Download `schemes/Tomorrow*.itermcolors` from

   [mbadolato/iTerm2-Color-Schemes](https://github.com/mbadolato/iTerm2-Color-Schemes).

2. Open Preferences… > Profiles > Colors.

3. Click 'Load Presets…' and select 'Import…'.

4. Select downloaded `Tomorrow*.itermcolors`.

5. Click 'Load Presets…' again and select one of Tomorrow Theme.

## License

Copyright © Chayoung You. See [LICENSE.txt](LICENSE.txt) for details.