Merge pull request #12 from kdkasad/patch-1

[dwmblocks.git] / README.md

diff --git a/README.md b/README.md
index de20aac96d1fe9cc96c7441e8f767deeb357b528..33f4e9de34b1b2bdf59161e0ff383d21895aec6f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,15 @@
 # dwmblocks
 Modular status bar for dwm written in c.
+# usage
+To use dwmblocks first run 'make' and then install it with 'sudo make install'.
+After that you can put dwmblocks in your xinitrc or other startup script to have it start with dwm.
+# modifying blocks
+The statusbar is made from text output from commandline programs.
+Blocks are added and removed by editing the blocks.h header file.
+By default the blocks.h header file is created the first time you run make which copies the default config from blocks.def.h.
+This is so you can edit your status bar commands and they will not get overwritten in a future update.
+# patches
+Here are some patches to dwmblocks that add features that I either don't want to merge in, or that require a dwm patch to work.
+I do not maintain these but I will take pull requests to update them.
+<br>
+<a href=https://gist.github.com/torrinfail/fb423345f0f9c340db25181c8159cdd2>dwmblocks-statuscmd-signal.diff</a>