summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bd564d3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# KaZoe Desktop
+This project provide a desktop environement base on "Qt Wayland Compositor".
+
+It combine features:
+
+- Wayland compositor
+- Window manager
+- customizable Task bar
+- customizable systray
+- homepage provided by an external application
+- VNC server managed by a plugin
+
+
+# Build and run
+```sh
+git clone https://kazoe.org/cgit/kazoe/kazoe-desktop.git
+cd kazoe-desktop
+mkdir build
+cmake ..
+make
+./kzdesktop
+```
+
+DesktopManager use [standard XDG paths](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html).
+This paths can be override by setting [XDG_DATA_HOME and XDG_DATA_DIRS](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html).
+
+
+## Design
+
+
+
+
+
+## Protocol
+https://specifications.freedesktop.org/menu-spec/menu-spec-1.0.html#desktop-entry-extensions-examples