forked from NotAShelf/beer
docs: initial project README
Signed-off-by: NotAShelf <raf@notashelf.dev> Change-Id: Ifce7143b8734868250a7665463ac344a6a6a6964
This commit is contained in:
parent
35ea435776
commit
b5c80f5921
1 changed files with 20 additions and 0 deletions
20
README.md
Normal file
20
README.md
Normal 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.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue