From 406769659f15e384c8427850312af7deaf866afc Mon Sep 17 00:00:00 2001 From: Santiago Lo Coco Date: Fri, 11 Mar 2022 09:17:40 -0300 Subject: [PATCH] Update README --- README | 48 +++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 47 insertions(+), 1 deletion(-) diff --git a/README b/README index 154963f..eba38cc 100644 --- a/README +++ b/README @@ -1 +1,47 @@ -My dwm build. +# cdwm + +Heavily-patched build of dwm. + +## Table of contents + - [Installation ](#installation-) + - [Usage ](#usage-) + - [Dependencies ](#dependencies-) + - [Contributing ](#contributing-) + - [License ](#license-) + +## Installation + +You need to run: + +```bash +make clean install +``` + +## Usage + +To run `cdwm`: + +```bash +exec dwm +``` + +## Dependencies + +You need to install [libxft-bgra][1]. + +## Patches + +- Clickable statusbar. +- Scratchpad. +- True fullscreen. +- Sticky windows. +- Stacker. +- Shiftview. +- Gaps. + +## Contributing +PRs are welcome. + +## License +[MIT](https://raw.githubusercontent.com/santilococo/cdwm/master/LICENSE.md) +