docs: initial project README

Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: Ifce7143b8734868250a7665463ac344a6a6a6964
This commit is contained in:
raf 2026-06-22 16:48:07 +03:00
commit b5c80f5921
No known key found for this signature in database
GPG key ID: 29D95B64378DB4BF

20
README.md Normal file
View file

@ -0,0 +1,20 @@
# beer
A fast, software-rendered, **Wayland-native** terminal emulator written in Rust.
Lightweight in dependencies, on disk, and in memory.
## Build
A Nix dev shell provides the toolchain and native libraries:
```sh
# Enter a devshell for necessary deps
$ nix develop
# Build in release mode
cargo build --release
```
## License
EUPL-1.2.