This repository supports the following configuration files.
| Type | Fully supported | Partially supported | No longer supported |
|---|---|---|---|
| Shells | Zsh | ||
| Editors | Vim VS Code |
Emacs Sublime Text 3 |
|
| OS | macOS | Windows Ubuntu Server |
|
| Package managers | Homebrew APT |
- Fully supported
- All configuration works fine. New configuration will be added, and existing configuration will be fixed if bugs exist.
- Partially supported
- Some configuration may not work properly. For example, due to the lack of commands. These problems will be fixed, but it may take a while.
- No longer supported
- The configuration files will not be supported.
You should move the original dotfiles to somewhere else if they exist. The target dotfiles are all files in core/ directory.
The following commands are used during the setup. Please install them.
curlgit (>= 2.8)
It is recommended to install Git 2.8 or higher.
Run the setup script. You need to change directories so you can run it in dotfiles directory.
cd dotfiles
./setup
exit
# This may take a lot of time
# You may need to enter your login password during installation
# You should do this twice to install items in the App Store
brew bundle install --global --no-lock
brew bundle install --global --no-lock
asdf plugin add ruby https://github.com/asdf-vm/asdf-ruby.git
asdf install ruby $(cat .ruby-version)
gem install bundler
bundle install
asdf plugin add nodejs https://github.com/asdf-vm/asdf-nodejs.git
asdf install nodejs $(cat .node-version)
npm install
sudo ln -s ~/.vimrc /root/.vimrc
sudo ln -s ~/.vim /root/.vimIMPORTANT NOTE 1: You should install Vim plugins and quit it when it’s started up while executing a setup script.
IMPORTANT NOTE 2: Node packages to be used globally are installed locally in dotfiles/node_modules and called from dotfiles/node_modules/.bin globally because npm cannot install packages globally from package.json (npm install -g is invalid). The option -g should not be added when new package will be installed because the package will not be added to package.json.
This dotfiles depends on the following.
| Dependency | Version | Reason why this version needed |
|---|---|---|
| Git | >= 2.8 |
Using useConfigOnly in .gitconfig |
| Ruby | >= 2.5.1 |
No guarantee self-making commands work fine under the lower version |
| Homebrew | any |
n/a |
- It is recommended to run the setup script every time new files are added.
- If you want to add your additional Git configuration, just add them to
gitconfig.local.