summaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorfpi2020-07-15 22:41:26 +0200
committerfpi2020-07-15 22:44:56 +0200
commit622e94a68126d7670a2dd40317e23730fccc153b (patch)
tree429442e49c1d00e76cba9164485bd080cb76c033 /README.org
parentAdd dots script (diff)
Add make install target for fresh installations
Diffstat (limited to '')
-rw-r--r--README.org11
1 files changed, 10 insertions, 1 deletions
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