From 4e43d4e467c1163789e2dc7ce61774bd8771c869 Mon Sep 17 00:00:00 2001 From: Alan Pearce Date: Mon, 20 Mar 2017 08:58:52 +0100 Subject: Update README --- README.org | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) (limited to 'README.org') diff --git a/README.org b/README.org index b6c5c092..e1fb43b3 100644 --- a/README.org +++ b/README.org @@ -1,8 +1,14 @@ * 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 -- cgit 1.4.1 From f8ec71a117760f22e2573f1a6d072547d6410f21 Mon Sep 17 00:00:00 2001 From: Alan Pearce Date: Mon, 20 Mar 2017 12:38:16 +0100 Subject: Add installation section to readme --- README.org | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'README.org') diff --git a/README.org b/README.org index e1fb43b3..b22c80b1 100644 --- a/README.org +++ b/README.org @@ -12,3 +12,18 @@ It should work on: - 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 -- cgit 1.4.1 From 061b7a0149c62f53a75f7f0e8ad63836acf4e334 Mon Sep 17 00:00:00 2001 From: Alan Pearce Date: Mon, 20 Mar 2017 12:42:46 +0100 Subject: Move zsh install commands to readme --- README.org | 17 +++++++++++++++++ hooks/post-up/zsh | 29 ----------------------------- 2 files changed, 17 insertions(+), 29 deletions(-) delete mode 100755 hooks/post-up/zsh (limited to 'README.org') diff --git a/README.org b/README.org index b22c80b1..68aaef49 100644 --- a/README.org +++ b/README.org @@ -27,3 +27,20 @@ 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. diff --git a/hooks/post-up/zsh b/hooks/post-up/zsh deleted file mode 100755 index 3eef6e51..00000000 --- a/hooks/post-up/zsh +++ /dev/null @@ -1,29 +0,0 @@ -#!/usr/bin/env zsh -ZDOTDIR="${XDG_CONFIG_HOME:=~/.config}/zsh" - -pushd $ZDOTDIR -for f in z*(-.) -do - if [[ -e .$f ]] - then - if [[ ! -h .$f ]] - then - echo ".$f already exists as a regular file, ignoring" - fi - else - ln -s $f .$f - fi -done -popd - -if [[ ! -d ~/.cache/zsh ]] -then - mkdir -p ~/.cache/zsh -fi - -if [[ -z $commands[zplug] && ! -d ~/projects/zplug/ ]] -then - git clone git://github.com/zplug/zplug ~/projects/zplug/ -fi - -zsh -ic "zplug install" -- cgit 1.4.1 From 05f574baa9e43499a13460bdfbb5140fcf957d6d Mon Sep 17 00:00:00 2001 From: Alan Pearce Date: Mon, 20 Mar 2017 14:19:04 +0100 Subject: Add Emacs section to readme --- README.org | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'README.org') diff --git a/README.org b/README.org index 68aaef49..7333ed34 100644 --- a/README.org +++ b/README.org @@ -44,3 +44,13 @@ zsh -ic "zplug install" 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 -- cgit 1.4.1