add readme

This commit is contained in:
anna 2022-01-19 02:33:39 +01:00
parent 7680f2f614
commit 02e9ad57eb
Signed by: fef
GPG key ID: EC22E476DC2D3D84

34
README.md Normal file
View file

@ -0,0 +1,34 @@
# `/dev/keymash`
Finally, it is here: The gay keymash device driver!
It provides an endless supply of lowercase characters from the
QWERTY home row in a cryptographically secure random order.
## Building
You only need the linux headers for your current kernel in `/lib/modules/$(uname -r)/build`.
If you install the `linux-headers` package (or something with similar name), you should be good.
Just type
```
make
sudo insmod keymash.ko
```
to compile and load the module.
It will create the file `/dev/keymash`, which you can use for all sorts of stuff:
```sh
# print a keymash to the console
head -c20 /dev/keymash
# wipe your disk for the FBI
sudo dd if=/dev/keymash of=$(mount | grep '/ ' | cut -d ' ' -f 1) bs=1M
# react to your girlfriend caling you cute
cat /dev/keymash | nc gay.wife 1337
```
## License
This is licensed under Dual BSD+GPLv2, but i don't really give a fuck what you do with the code.