From 904b2737ccffb31c02cf88cb75310fc2a72ddfbd Mon Sep 17 00:00:00 2001
From: Tom Willemsen
Date: Thu, 17 May 2012 21:26:30 +0200
Subject: Add some documentation

I like both python's and (e)lisp's way of documenting functions on the
inside, even though I don't know of any system that does that reads it
this way for C, I'm still trying it out.
---
 src/README.org | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 src/README.org

(limited to 'src/README.org')

diff --git a/src/README.org b/src/README.org
new file mode 100644
index 0000000..569b2ee
--- /dev/null
+++ b/src/README.org
@@ -0,0 +1,14 @@
+* Benjamin A's PS1
+
+  To use it as it was intended put the following in your ~PS1~ or
+  ~PROMPT~ variable, depending on whether you use ~bash~ or ~zsh~:
+
+  #+BEGIN_SRC shell-script
+  PS1="\$(/path/to/baps1)"
+  #+END_SRC
+
+  Or, if you like single quotes, use:
+
+  #+BEGIN_SRC shell-script
+  PS1='$(/path/to/baps1)'
+  #+END_SRC
-- 
cgit v1.2.3-54-g00ecf