cst/README.md

49 lines
1002 B
Markdown

# cst
Heavily-patched build of `st`.
## Table of contents
- [Requirements <a name="requirements"></a>](#requirements-)
- [Installation <a name="installation"></a>](#installation-)
- [Usage <a name="usage"></a>](#usage-)
- [Patches <a name="patches"></a>](#patches-)
- [Contributing <a name="contributing"></a>](#contributing-)
- [License <a name="license"></a>](#license-)
## Requirements <a name="requirements"></a>
In order to build `st` you need the `Xlib` header files and [libxft-bgra][1].
## Installation <a name="installation"></a>
You need to run:
```bash
make clean install
```
## Usage <a name="usage"></a>
To run `cst`:
```bash
st
```
## Patches <a name="patches"></a>
- Anysize.
- Blinking cursor.
- Secondary font.
- Scrollback.
- Gruvbox.
## Contributing <a name="contributing"></a>
PRs are welcome.
## License <a name="license"></a>
[MIT](https://raw.githubusercontent.com/santilococo/cst/master/LICENSE)
[1]: https://aur.archlinux.org/packages/libxft-bgra