Skip to content

zhimsel/dotfiles

Repository files navigation

zhimsel/dotfiles

These are my config files. I use them live, in 'production'. You're welcome to use them directly, or fork them. Keep in mind they may change suddenly, frequently, and for seemingly no reason. They may (and do) break. Use them at your own risk (minimal as that is).

If you think you have an improvement, feel free to submit an issue or pull request.

Install

This repo is intended to be based directly in your home directory, with a .git dir named as something else (as to not cause all subdirectories to think they're a git repo). To do an initial clone of this repo, follow the steps below:

cd $HOME
export GIT_DIR=$HOME/.git_dotfiles GIT_WORK_TREE=$HOME
git init
git remote add origin git@github.com:zhimsel/dotfiles.git
git fetch
git checkout --track -b main origin/main  # will report any conflict files; back these up and re-run
git submodule update --init --recursive

Then, start a new shell (which will install zinit and plugins) and run vim to install lazy.nvim and its plugins.

You can then use the included dot alias (in $HOME/.zshrc) to perform git commands against the dotfiles repo. To track new dotfiles, you need to use git add -f, since everything is ignored by default. Use the nodot alias to stop working on the dotfiles repo.

To update all the required zsh and vim plugins, use the included dotu command (in .zshrc).

OS-specific setup

MacOS/OSX

Install Homebrew and run:

brew bundle --global install

Arch Linux

Install your choice of AUR-helper (I recommend yay) and do:

yay -Syu --needed - < .arch-packages.list

Keyboard configuration

ZSA Moonlander

I primarily use a ergonomic split keyboard from ZSA called the Moonlander. My current configuration and key maps can be found on ZSA's online Oryx configurator tool. I also maintain a mirror of the firmware source code in this Github repo.

License

These files are licensed under the MIT license and are freely available for any use.