From 181bf9b875e9e4b6338be6bba3dea747ce6f0508 Mon Sep 17 00:00:00 2001
From: Ryan Brue <ryanbrue@gmail.com>
Date: Sun, 11 Aug 2024 15:20:14 -0500
Subject: [PATCH] docs: add a simple README describing the project

Signed-off-by: Ryan Brue <ryanbrue@gmail.com>
---
 README.adoc | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 README.adoc

diff --git a/README.adoc b/README.adoc
new file mode 100644
index 0000000..2f1e692
--- /dev/null
+++ b/README.adoc
@@ -0,0 +1,32 @@
+= ryanabx-shell
+A compositor-agnostic desktop shell!
+
+NOTE: This project is under heavy development, and will probably not be "stable" for a while.
+
+Welcome to a desktop shell that's intended to run on any compositor! To be more specific, this would be any compositor that implements `wlr-layer-shell`.
+
+The currently planned compositors to be supported are:
+
+* https://github.com/pop-os/cosmic-comp[cosmic-comp] (First primary target)
+* https://invent.kde.org/plasma/kwin[KWin]
+* https://gitlab.freedesktop.org/wlroots/wlroots[Wlroots-based compositors]
+
+This shell is intended to be similar to Windows-style desktops, with a launcher in the bottom left, a list of favorite apps in the middle or left (configurable), and a tray with settings on the right! The designs aren't fully finished at the moment, but that's the general direction I'd like to go.
+
+The shell is proudly built entirely in https://www.rust-lang.org/[Rust]! 
+
+== Build instructions (Ubuntu/Fedora instructions)
+
+[source, shell]
+----
+# Install Dependencies (Ubuntu)
+sudo apt-get install -y libxkbcommon-dev
+# Install Dependencies (Fedora)
+sudo dnf install -y libxkbcommon-devel
+# Build
+cargo build
+----
+
+== Contributing
+
+Since a lot of the development is personal, the first thing you should do if you'd like to contribute is https://github.com/ryanabx/ryanabx-shell/issues/new[submit an issue] describing the feature you'd like to implement. This helps to avoid potential duplicate work if I'm already working on such a feature!
\ No newline at end of file