summaryrefslogtreecommitdiffstats
path: root/desktop/wf-shell/README
diff options
context:
space:
mode:
Diffstat (limited to 'desktop/wf-shell/README')
-rw-r--r--desktop/wf-shell/README8
1 files changed, 8 insertions, 0 deletions
diff --git a/desktop/wf-shell/README b/desktop/wf-shell/README
new file mode 100644
index 0000000000..80a1d22c6e
--- /dev/null
+++ b/desktop/wf-shell/README
@@ -0,0 +1,8 @@
+wf-shell is a repository which contains the various components needed
+to built a fully functional DE based around wayfire.
+Currently it has only a GTK-based panel and background client.
+
+To configure the panel and the dock, wf-shell uses a config file located
+(by default) in ~/.config/wf-shell.ini An example configuration
+can be found in the file wf-shell.ini.example, alongside with comments
+what each option does.