matir/skel
1
0
Fork 0
mirror of https://github.com/Matir/skel.git synced 2026-05-25 21:19:09 -07:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation.

Browse Source
This commit is contained in:
David Tomaschik
2015-10-01 14:02:21 -07:00
parent d1696d88f1
commit 8a84e547e1
1 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -4,8 +4,24 @@ This is a repository of configuration files that I like to have on all the
machines that I use. I can just clone the repository and run "repo/setup.sh"
and get most things setup the way I like them.
This started just as dotfiles, but expanded to include SSH keys, GPG keys,
packages I like installed, and an ever-growing setup script. There are various
options to install just parts of it, such as on a machine where I only have a
user account but no root.
### Usefulness ###
Mostly I post this to github so I can quickly grab the things I want, but it
might also be useful to others. Feel free to raise an issue if you have any
questions. I don't anticipating taking merge requests -- make your own
dotfiles. ;)
### Options ###
```
BASEDIR: Where the skel framework is installed. Defaults to $HOME/.skel
MINIMAL: Don't do things that require git clones or installation of anything
not included in my .skel. (Defaults to 0, installs everything.)
INSTALL_KEYS: Install GnuPG and SSH keys. SSH keys are placed in
authorized_keys. (Defaults to 1, installs keys.)
INSTALL_PKGS: Install common packages, if on a Debian-like system.
(Defaults to opposite of $MINIMAL.)
```