Update README.md

README.md

@@ -1,72 +1,41 @@
-# dwmblocks
+# cdwmblocks
 
-Modular status monitor for dwm written in C with features including
+Build of `dwmblocks`.
-signaling, clickability, cursor hinting and color.
 
-# Usage
+## Table of contents
+  - [Requirements <a name="requirements"></a>](#requirements-)
+  - [Installation <a name="installation"></a>](#installation-)
+  - [Usage <a name="usage"></a>](#usage-)
+  - [Contributing <a name="contributing"></a>](#contributing-)
+  - [License <a name="license"></a>](#license-)
 
-`dwmblocks`
+## Requirements <a name="requirements"></a>
 
-# Configuration
+In order to build `dwmblocks` you need the `Xlib` header files and [libxft-bgra][1].
 
-Refer to [config.h](config.def.h). It allows addition/removal of blocks and a
+## Installation <a name="installation"></a>
-few other configurations.
 
-> `make`, the first time you run it, or `make config.h` will create config.h by
+You must apply the appropiate patch (depending on whether you already patched dwm with the systray patch or not) to dwm (see `patches` folder).
-> copying [config.def.h](config.def.h).
 
-> The provided blocks use siji font for icons.
+Then, you need to run:
 
-# Colored output and Clickability
+```bash
-
+make clean install
-[patches](patches) folder contains two patches for dwm, one for dwm already
-patched with systray patch and the other for vanilla dwm. One of the patches,
-whichever appropriate, is essential for dwmblocks to function properly. It will
-add support for colored text, clickability and cursor hinting when hovering on
-clickable blocks (inspired by polybar).
-
-Clickability is inspired by statuscmd patch for dwm. On clicking on text
-corresponding to a clickable block, the program specified to handle clicks for
-that block is executed with the first argument specifying which button was
-clicked (1 for left, 2 for middle and 3 for right).
-
-Colored output is inspired by statuscolors patch for dwm. To add colors, have
-your programs for the blocks output raw characters from `\x0b` to `\x1f`. `\x0b`
-in status text switches active colorscheme to the first one in the colors array
-defined in dwm's config.h and so on. See
-[statuscolors patch for dwm](https://dwm.suckless.org/patches/statuscolors/)
-for more info. Keep in mind that you have to start from `\x0b` instead of `\x01`
-as instructed on the page.
-
-# Signaling changes
-
-To signal a specific block to update, run `sigdwmblocks <signal> [<sigval>]`.
-`<sigval>` is optional and must be an integer. If provided, it is passed as the
-first argument to the program specified for updating the block.
-
-# xgetrootname
-
-A tiny program to get the current root name. May prove helpful in debugging.
-
-# Installation
-
-Clone the repository and run
-```
-cd dwmblocks
-make
-sudo make install
 ```
 
-# Acknowledgements
+## Usage <a name="usage"></a>
 
-Some ideas and code was taken from other projects. Credits for those go to -
+To run `cdwmblocks`:
 
-* torrinfail ([original dwmblocks implementation](https://github.com/torrinfail/dwmblocks))
+```bash
-* Daniel Bylinka ([statuscmd patch for dwm](https://dwm.suckless.org/patches/statuscmd/))
+dwmblocks
-* Jeremy Jay ([statuscolors patch for dwm](https://dwm.suckless.org/patches/statuscolors/))
+```
 
-# See also
+## Contributing <a name="contributing"></a>
+PRs are welcome.
+
+## License <a name="license"></a>
+[MIT](https://raw.githubusercontent.com/santilococo/cdwmblocks/master/LICENSE)
+
+[1]: https://aur.archlinux.org/packages/libxft-bgra
 
-* [dsblocks](https://github.com/ashish-yadav11/dsblocks) - A clone of this
-  project with the only difference being that C functions instead of external
-  programs are used to update blocks and handle clicks.