aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorMarvin Borner2019-05-27 19:37:15 +0200
committerMarvin Borner2019-05-27 19:37:15 +0200
commitde517f3a9aacd871c5e72b5409846ab0b64bc888 (patch)
treebe7940997d8ce3ebe59620a84a60a1cc8009b603
parentb4f1926b48cb5a6016f03c3d7ca7b2e196e8f767 (diff)
Added instructions
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index a8738d5..cc61c10 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,11 @@
-# FreedoWM \ No newline at end of file
+# FreedoWM
+<small><i>Pronunciation: /ˈfɹiːdəm/</i></small>
+
+### Installation
+There are two scripts helping you to install FreedoWM:
+1. setup.py
+ * Installs FreedoWM to your path but doesn't configure the desktop manager to show the option of using FreedoWM
+ * Example: `sudo python3.7 setup.py install`
+2. install.sh
+ * Executes `setup.py` and configures your desktop manager (it also adds the freedowm-session executable)
+ * Example: `sudo ./install.sh` \ No newline at end of file