Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zmwangx/dotfiles
My config files on macOS (also works on Linux, but with limited testing).
https://github.com/zmwangx/dotfiles
dotfiles
Last synced: 3 months ago
JSON representation
My config files on macOS (also works on Linux, but with limited testing).
- Host: GitHub
- URL: https://github.com/zmwangx/dotfiles
- Owner: zmwangx
- License: mit
- Created: 2015-05-03T01:02:16.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-10-28T07:05:19.000Z (about 7 years ago)
- Last Synced: 2023-06-03T23:05:13.828Z (over 1 year ago)
- Topics: dotfiles
- Language: Shell
- Homepage:
- Size: 729 KB
- Stars: 23
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
This repository contains most of my vital config files.
## Table of contents
- [Getting started](#getting-started)
- [XDG offenders](#xdg-offenders)
- [License](#license)
## Getting started
```zsh
git clone --recursive [email protected]:zmwangx/dotfiles.git ~/.config
# create data/cache directories and link some dotfiles or dot directories to HOME
~/.config/setup
```
If `~/.config` already exists and is nonempty, then one should instead run the
following:
```zsh
cd ~/.config
git init
git remote add origin [email protected]:zmwangx/dotfiles.git
git fetch --all
git reset --hard origin/master
git submodule update --init --recursive
~/.config/setup
```
To provision a new OS X install, do `~/.config/provision` instead (requires
Xcode and CLT). Note that `provision` supports various options; please refer to
`~/.config/provision --help`.
_**Warning**. I haven't gone through the provision process for a long time, so
the provision script might be outdated._
Also, `source ~/.config/env` should go into `.bashrc`, `.zshenv` (done for you
when you run `~/.config/setup`, which sets up `.bashrc` and `.zshenv` in your
home directory), and its equivalent should go into the runcoms of other
noninteractive (POSIX-compatible) shells.
Note that config files with credentials have been excluded from the directory,
and their `.template` counterparts have been committed in instead. Replace the
redacted credentials (generally in the form `XXXXXX`) with the actual values.
## XDG offenders
You are invited to visit the Homedir Hall of Shame
([`HALLOFSHAME.md`](HALLOFSHAME.md)).
## License
First party code in this repository is licensed under the MIT License (see
[`LICENSE`](LICENSE) for details). Third party code in submodules may be
separately licensed, and please refer to individual submodules or files for
details.