Add README.HEADmaster

1 files changed, 24 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..b586110
--- /dev/null
+++ b/README
@@ -0,0 +1,24 @@
+Urchlay's ck4up config.
+
+This requires ck4up-1.6 or greater.
+
+This won't work as-is for you, unless you're really interested in
+checking the status of *my* SlackBuilds. You'll have to create your
+own *.conf files; mine are just there as examples.
+
+How to install this:
+
+Do this as a normal user (not root):
+
+cd
+git clone https://slackware.uk/~urchlay/repos/ck4up-config
+
+# either install to ~/bin:
+mkdir -p ~/bin  # if you don't already have one
+ln -s ~/ck4up-config/{ck,ck.,ckall,perlupd} ~/bin
+vi ~/.bash_profile   # add ~/bin to $PATH if it's not already there
+
+# or else add ~/ck4up-config to your $PATH.
+
+Create a ~/.ck4up/ directory, have a look at my *.conf files and
+use them as a basis for writing your own.