aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..161293a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+mstatus
+=======
+`mstatus` is a minimal status bar for the DWM window manager. The status bar is comprised of a
+series of blocks which can be added, modified, and deleted by sending simple commands to a file.
+
+For usage instructions see the `mstatus(1)` manual page.
+
+
+Installation
+============
+Assuming you have cloned the repo, you can install the status bar and manual page in two commands.
+
+```sh
+$ make
+$ make install # Will require root permissions
+```