aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNPScript <nathan@reinerweb.ch>2021-12-14 00:29:44 +0100
committerNPScript <nathan@reinerweb.ch>2021-12-14 00:29:44 +0100
commit823dae8d0192c67cc42d2942de1bb0c15bb921c1 (patch)
treec048ce5bd0935b96079f5133b003b44673bab0de /README.md
parent72109536ec82c27e49dcc91559aec7fce62bc9f8 (diff)
parentb2b7284c755d6a950ad3282e922272fa561b9e34 (diff)
c or cpp files
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/README.md b/README.md
index e2f4bfc..5eb1e09 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# 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.
+Scrubs is a little documentation tool written in POSIX-Shell. It should make easier to work in teams in a suckless way, without having to it without any documentation.
## Features
@@ -32,7 +32,7 @@ The `TODO` tag has the following structur:
* @category some_bug
*
* @description
- * Some weared bug lol
+ * Some weird bug lol
* what is this???
*/
```
@@ -46,6 +46,7 @@ There is a *Makefile* so you are able to install `scrubs` with:
``` bash
sudo make install
```
+Note that if you want to use the `search` functionality of `scrubs` you have to install `fzf`.
To uninstall