first commit

1 files changed, 54 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e2f4bfc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+# SCRUBS - Let's Prepare The Operation
+
+Scrubs is a little documentation tool written in POSIX-Shell. It should make easier to work in teams in a suckless way.
+
+## Features
+
+There are two kinds of tags which are displayed in scrubs, `DOC` and `TODO`.
+
+`DOC` is used to document your functions or classes. It has the following structur:
+
+``` c++
+/** DOC
+ * @type function
+ * @name some_random_function
+ *
+ * @param input * data
+ * the input data for processing
+ *
+ * @return output
+ *
+ * @description
+ * Here you have the function description.
+ * It is allowed to have multiple lines.
+ * Isn't that cool?
+ */
+```
+
+The `TODO` tag has the following structur:
+
+``` c++
+/** TODO
+ * @category some_bug
+ *
+ * @description
+ * Some weared bug lol
+ * what is this???
+ */
+```
+
+*For more examples see `example.cpp`*
+
+## Install
+
+There is a *Makefile* so you are able to install `scrubs` with:
+
+``` bash
+sudo make install
+```
+
+To uninstall
+
+``` bash
+sudo make uninstall
+```