aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 00a73e7feafdd669140f9a1d22bbc99d952445f0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# xkcd1172

Rapidly increases CPU temperature when holding down the spacebar.

***https://xkcd.com/1172***

![xkcd 1172: Workflow](https://imgs.xkcd.com/comics/workflow.png)

## Installation

```sh
$ pip3 install xkcd1172
```

### Requirements

- Xorg (Wayland works if you are focused on an Xwayland window)
- Spacebar
- CPU

## Building

```sh
$ git clone https://git.dawidpotocki.com/dawid/xkcd1172
$ cd xkcd1172

$ python3 -m build
$ pip3 install dist/xkcd1172-<version>-py3-none-any.whl
```

## Running standalone

```sh
$ xkcd1172
```

### Autostart

```sh
$ xkcd1172 -a  # Add to XDG autostart
$ xkcd1172 -r  # Remove from XDG autostart
```

## Running as a library

```py
import xkcd1172

xkcd1172.start_daemon_thread()
```