aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 539e6f338b7559a5bd2aefb3b40c7dfe3bce91b5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# lockrs

A minimal X11 lockscreen make with xcb and rust.

## Installation

Clone the repo and then run:

```
cargo install --path .
```

ensure that `~/.cargo/bin` is on your PATH to be able to launch the application.

## Usage

You can run it from the command line or a launcher with `lockrs` or you could setup an auto lockscreen functionality like this `xautolock -time 5 -locker lockrs`. Note: xautolock is external software that you would need to download.