Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zhimsel/dotfiles
My config files
https://github.com/zhimsel/dotfiles
dotfiles neovim shell vim vimrc zsh zshrc
Last synced: 1 day ago
JSON representation
My config files
- Host: GitHub
- URL: https://github.com/zhimsel/dotfiles
- Owner: zhimsel
- Created: 2013-09-26T03:54:19.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2024-11-07T15:59:58.000Z (6 days ago)
- Last Synced: 2024-11-07T16:47:42.877Z (6 days ago)
- Topics: dotfiles, neovim, shell, vim, vimrc, zsh, zshrc
- Language: Lua
- Homepage:
- Size: 2.54 MB
- Stars: 16
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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:
```sh
cd $HOME
export GIT_DIR=$HOME/.git_dotfiles GIT_WORK_TREE=$HOME
git init
git remote add origin [email protected]: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](https://docs.brew.sh/Installation) and run:
```sh
brew bundle --global install
```
#### Arch Linux
Install your choice of AUR-helper (I recommend [`yay`](https://aur.archlinux.org/packages/yay/)) and do:
```sh
yay -Syu --needed - < .arch-packages.list
```
## Keyboard configuration
### ZSA Moonlander
I primarily use a [ergonomic split keyboard from ZSA called the _Moonlander_](https://www.zsa.io/moonlander/).
My current configuration and key maps can be found [on ZSA's online _Oryx_ configurator tool](https://configure.zsa.io/moonlander/layouts/XE4RP). I also maintain a mirror of the firmware source code in [this Github repo](https://github.com/zhimsel/moonlander-config).
## License
These files are licensed under the [MIT license](/LICENSE) and are freely available for any use.