summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Makefile9
-rw-r--r--README.org11
2 files changed, 17 insertions, 3 deletions
diff --git a/Makefile b/Makefile
index 92b04f5..033ac9a 100644
--- a/Makefile
+++ b/Makefile
@@ -1,9 +1,11 @@
-.PHONY: merge tangle
+.PHONY: merge install link tangle fetch pull
merge:
tangle/merge.sh
-tangle:
+install: tangle link
+
+tangle: tangle/tangle.sh
tangle/tangle.sh
link:
@@ -14,3 +16,6 @@ fetch:
pull:
tangle/pull.sh
+
+tangle/tangle.sh: README.org
+ emacs --batch --eval "(and (require 'org) (org-babel-tangle-file \"README.org\"))"
diff --git a/README.org b/README.org
index 893befd..0afa693 100644
--- a/README.org
+++ b/README.org
@@ -9,7 +9,16 @@ The symlinks can be created by manually running the appropriate [[https://orgmod
source block in each configuration file or by running the scripts
below.
-** Git Setup
+** Initial setup
+After cloning this repository run
+
+#+begin_example shell
+make install
+#+end_example
+
+to setup the tangled config files and create the necessary symlinks.
+
+** Git setup
This repository somewhat abuses git branches. Every program's
configuration lives in its own separate branch. All branches are then
merged into =master= using an [[https://git-scm.com/docs/merge-strategies#Documentation/merge-strategies.txt-octopus][octopus merge]]. To keep the git history