https://github.com/mdzhang/dotfiles
My personal dotfiles
https://github.com/mdzhang/dotfiles
dotfiles espanso git macos neovim nvim stow vim zsh
Last synced: 8 months ago
JSON representation
My personal dotfiles
- Host: GitHub
- URL: https://github.com/mdzhang/dotfiles
- Owner: mdzhang
- License: mit
- Created: 2016-01-28T02:48:59.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-06-12T14:54:13.000Z (over 1 year ago)
- Last Synced: 2024-06-12T20:18:19.035Z (over 1 year ago)
- Topics: dotfiles, espanso, git, macos, neovim, nvim, stow, vim, zsh
- Language: Shell
- Homepage:
- Size: 939 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [Dotfiles](https://dotfiles.github.io/)
Laptop setup scripts and personal dotfiles. Uses [GNU Stow][stow]
Supports:
* OS X Ventura
* (K)Ubuntu 18.04
Older versions may work but aren't regularly tested
## Prerequisites
- Packages installed by [laptop script](https://github.com/mdzhang/laptop)
## Installation
Installs source code to `~/.dotfiles` by default
1. Grab source code
```sh
git clone git@github.com:mdzhang/dotfiles.git ~/.dotfiles
git submodule init && git submodule update --init --recursive
```
1. Customize with your personal info
- Replace occurrences of `mdzhang` with your system user name (for me this is also my git handle)
- Replace occurrences of `md.zhang.aka@gmail.com` with your email
- Replace occurrences of `m d zhang` with your full name
- Update GPG `user.signingkey` in `git/.gitconfig`
1. Install [`stow`][stow] on your OS
1. Stow folders you're interested in
```sh
stow git
stow bash
stow sh
stow vim
...
```
1. Remove them later if you want
```sh
stow -D bash
stow zsh
```
### Sensitive Information
Add to `sh/.config/sh/general/secrets.sh`
## Authors
**m d zhang**
*
## License
Copyright (c) 2013-2023 m d zhang. MIT Licensed, see [LICENSE](./LICENSE) for details.
[stow]: https://www.gnu.org/software/stow/manual/stow.html