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.

1 files changed, 14 insertions, 0 deletions

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