1 files changed, 40 insertions, 0 deletions
diff --git a/desktop/nwg-shell/README b/desktop/nwg-shell/README
new file mode 100644
index 0000000000..76012273a1
--- /dev/null
+++ b/desktop/nwg-shell/README
@@ -0,0 +1,40 @@
+nwg-shell (base shell and utils for Sway-based shell)
+
+Base package of utils and configurations for nwg-shell.
+
+This package acts as a meta-package to pull in all
+the dependencies for building the entire nwg-shell
+project.
+
+Installation of the nwg-shell WM on Slackware:
+
+First build/install this package and all of
+the dependencies.
+
+Ensure your $USER is in the 'video' group.
+
+1. Run (as $USER) 'xdg-user-dirs-update'
+  (first launch only)
+2. then Run 'nwg-shell-installer -a'
+  (installs default skeleton config)
+3. Launch 'sway'
+
+After initial setup, one need only exec
+'sway' to load nwg-shell.
+
+By default nwg-shell uses:
+-playerctl (media player)
+-Firefox (web browsing)
+-mousepad (text editor)
+-thunar (file explorer)
+-gtklock (lockscreen)
+
+Ensure you have a full Slackware install
+(or everything but /kde). Default apps are
+from XFCE, so ensure you've installed the
+xfce/ package series.
+
+All defaults are user configurable within the WM.
+
+The nwg-shell project now has a optional graphical
+greeter based on greetd. Check out 'nwg-hello' on SBo!