From b5c80f5921b2770a7d1fa1df7afe774fedb851e0 Mon Sep 17 00:00:00 2001
From: NotAShelf <raf@notashelf.dev>
Date: Mon, 22 Jun 2026 16:48:07 +0300
Subject: [PATCH] docs: initial project README

Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: Ifce7143b8734868250a7665463ac344a6a6a6964
---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..334c400
--- /dev/null
+++ b/README.md
@@ -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.