aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Molodetskikh <yalterz@gmail.com>2023-08-10 14:45:54 +0400
committerIvan Molodetskikh <yalterz@gmail.com>2023-08-10 14:50:51 +0400
commitacd63fda731709df7db987e5c7aa134dd664e268 (patch)
tree1bd42d52aef1fbc27d8a2ff3257fb5410cd038bb
parent4daef8abdcffcd921082637658e3b856dc30e294 (diff)
downloadniri-acd63fda731709df7db987e5c7aa134dd664e268.tar.gz
niri-acd63fda731709df7db987e5c7aa134dd664e268.tar.bz2
niri-acd63fda731709df7db987e5c7aa134dd664e268.zip
Add README
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..668a9398
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# niri
+
+The beginnings of a Wayland compositor.
+
+## Running
+
+`cargo run -- -- alacritty`
+
+Inside a desktop session, it will run in a window. On a TTY, it will run natively.
+
+To exit when running on a TTY, press <kbd>Super</kbd>+<kbd>Shift</kbd>+<kbd>e</kbd>.
+