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

Merge pull request #10 from Matir/doc

Browse Source 
Cleanup README.
This commit is contained in:
David Tomaschik
2019-10-02 21:58:54 -07:00
committed by GitHub
parent 693b349024 9d85ae77fa
commit 8b9c9581e4
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -1,5 +1,5 @@
### About ### ### About ###
This is a repository of configuration files that I like to have on all the 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" 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. and get most things setup the way I like them.
@@ -14,12 +14,14 @@ This now uses [git-crypt](https://github.com/AGWA/git-crypt) to protect
I still wouldn't check in anything terribly sensitive, like private keys. I still wouldn't check in anything terribly sensitive, like private keys.
### Usefulness ### ### Usefulness ###
Mostly I post this to github so I can quickly grab the things I want, but it 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 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 questions. I don't anticipating taking merge requests -- make your own
dotfiles. ;) dotfiles. ;)
### Options ### ### Options ###
``` ```
BASEDIR: Where the skel framework is installed. Defaults to $HOME/.skel BASEDIR: Where the skel framework is installed. Defaults to $HOME/.skel
MINIMAL: Don't do things that require git clones or installation of anything MINIMAL: Don't do things that require git clones or installation of anything
@@ -31,9 +33,10 @@ INSTALL_PKGS: Install common packages, if on a Debian-like system.
(Defaults to opposite of $MINIMAL.) (Defaults to opposite of $MINIMAL.)
SAVE: Save the install options to ${BASEDIR}/installed-prefs SAVE: Save the install options to ${BASEDIR}/installed-prefs
``` ```
### TODO ### ### TODO ###
[ ] Re-do the installation of packages. - [X] Re-do the installation of packages.
[ ] Make manual installation of sets easy/possible. - [X] Make manual installation of sets easy/possible.
[ ] Make missing packages not cause a full set failure. - [X] Make missing packages not cause a full set failure.
[X] Allow comments and blank lines. - [X] Allow comments and blank lines. in packages