docs: update demo; add usage instructions

Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: I6c7565ca7190a93f9b9dd2434cdbfdcc6a6a6964
This commit is contained in:
raf 2026-04-07 14:43:42 +03:00
commit b464a0979a
Signed by: NotAShelf
GPG key ID: 29D95B64378DB4BF
3 changed files with 23 additions and 4 deletions

View file

@ -3,6 +3,8 @@
> Congratulations. You have reached the logical conclusion of your relationship > Congratulations. You have reached the logical conclusion of your relationship
> with modern computing. > with modern computing.
![Demo](./assets/demo.png)
flipoff is a Python-based utility that leverages _sophisticated computer vision_ flipoff is a Python-based utility that leverages _sophisticated computer vision_
to _solve the oldest problem in human-computer interaction_: the fact that your to _solve the oldest problem in human-computer interaction_: the fact that your
machine is still running when you no longer wish it to be. It monitors your machine is still running when you no longer wish it to be. It monitors your
@ -42,9 +44,26 @@ made. Built on three core pillars of modern engineering:
We have spent decades teaching computers to understand our speech and our touch. We have spent decades teaching computers to understand our speech and our touch.
It was about time we taught them to understand our boundaries. It was about time we taught them to understand our boundaries.
## Demo ## Building & Development
Here's Walter White flipping off your computer, to give you an idea of how it ### Prerequisites
operates:
<video src="/assets/waltuh.mp4" controls width=800/> - Python 3.11+
- [uv](https://github.com/astral-sh/uv)
- Bunch of system libraries (see `shell.nix` for a list)
Or, if you're sane, Nix. For now a very simple Nix development shell is provided
in `shell.nix`. Use either `diren allow` or `nix-shell` to get the dependencies.
### Running
```bash
# With webcam
$ uv run flipoff
# With debug overlay for landmarks
$ uv run flipoff --debug
# Dry run (no actual poweroff)
$ FLIPOFF_DRYRUN=1 uv run flipoff
```

BIN
docs/assets/demo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 156 KiB

Binary file not shown.