diff options
author | Alan Pearce | 2017-03-24 21:22:27 +0100 |
---|---|---|
committer | Alan Pearce | 2017-03-24 21:22:27 +0100 |
commit | bbb26322199d41171595bff6d073bda1fa1fa62c (patch) | |
tree | 799f160f60327a1b026fd9f4065636e611ccafb0 /README.org | |
parent | 0c4343e413bbc922954b417a639c60dfa007a0da (diff) | |
parent | 53f50286e177abb9d1ac4a7c239dcbcc3fed63b7 (diff) | |
download | nixfiles-bbb26322199d41171595bff6d073bda1fa1fa62c.tar.lz nixfiles-bbb26322199d41171595bff6d073bda1fa1fa62c.tar.zst nixfiles-bbb26322199d41171595bff6d073bda1fa1fa62c.zip |
Merge remote-tracking branch 'origin/master'
Diffstat (limited to 'README.org')
-rw-r--r-- | README.org | 58 |
1 files changed, 53 insertions, 5 deletions
diff --git a/README.org b/README.org index b6c5c092..7333ed34 100644 --- a/README.org +++ b/README.org @@ -1,8 +1,56 @@ * Dotfiles -I've organised this repository with [[https://github.com/thoughtbot/rcm][rcm]], using tag- and -host-specific directories. It focuses on zsh and emacs, with some -functions to go from zsh to emacs (and directly to dired and magit). -It doesn't use any configuration frameworks. +I've organised this repository with [[https://www.gnu.org/software/stow/][GNU Stow]]. It focuses on [[http://zsh.sourceforge.net][Z Shell]] and +[[http://emacs.sexy][Emacs]]. -Most likely to work on Linux, OSX and FreeBSD. +It doesn't use any configuration frameworks, just packages installed +via package managers. For Z shell I use [[https://zplug.sh/][zplug]] and for Emacs I use the +built-in package.el via [[https://github.com/jwiegley/use-package][use-package]]. + +It should work on: +- Linux +- OSX +- FreeBSD +- Windows/Ubuntu + +** Installation + +Installing a set of dotfiles with stow is simple. For example, with +Emacs: + +#+BEGIN_SRC sh :exports code +stow -S emacs +#+END_SRC + +And then to uninstall + +#+BEGIN_SRC sh :exports code +stow -D emacs +#+END_SRC + +*** Z Shell + +My zsh configuration uses [[https://zplug.sh/][zplug]], so that will need to be installed: + +#+BEGIN_SRC sh :exports code +git clone git://github.com/zplug/zplug ~/projects/zplug/ +#+END_SRC + +To install the packages: + +#+BEGIN_SRC sh :exports code +zsh -ic "zplug install" +#+END_SRC + +Note that this will log some errors about a pipe, but that's okay. +zplug is meant to be used in a real interactive shell. + +*** Emacs + +I use org-mode for my Emacs init file. To simplify setup, I created a +[[file:emacs/.emacs.d/Makefile][Makefile]]. + +#+BEGIN_SRC sh :exports code +cd ~/.emacs.d/ +make +#+END_SRC |