diff --git a/README.md b/README.md index 2dd0738..ff9364c 100644 --- a/README.md +++ b/README.md @@ -1 +1,47 @@ -My st build. +# cst + +Heavily-patched build of st. + +## Table of contents + - [Requirements ](#requirements-) + - [Installation ](#installation-) + - [Usage ](#usage-) + - [Contributing ](#contributing-) + - [License ](#license-) + +## Requirements + +In order to build dwm you need the Xlib header files and [libxft-bgra][1]. + +## Installation + +You need to run: + +```bash +make clean install +``` + +## Usage + +To run `cst`: + +```bash +st +``` + +## Patches + +- Anysize. +- Blinking cursor. +- Secondary font. +- Scrollback. +- Gruvbox. + +## Contributing +PRs are welcome. + +## License +[MIT](https://raw.githubusercontent.com/santilococo/cst/master/LICENSE) + +[1]: https://aur.archlinux.org/packages/libxft-bgra +