stashHEADmaster

1 files changed, 25 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f784c24
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+this project is for me. Here are the priorities
+
+- provide a complaint terminal emulator
+- minimise application start time; time from `rustty` to a window appearing
+- minimise build time; preferably builds from scratch in less than 30s
+
+long term goals:
+
+- emulate vt100
+- run nvim
+
+non-goals; never going to happen:
+
+- non-\*nix support
+- non-compiletime configuration
+
+rationale for the above:
+
+alacritty is nice but it takes forever to start. I like st's philosophy. I am writing something with st's philosophy in rust, because I know rust already.
+
+see `HACKING.md` for development tips
+
+run with `nix run --flake git+https://git.mtgmonkey.net/andromeda/rustty`
+
+build with cargo by cloning it and running `cargo build --release`