aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Tom Willemse2022-10-17 22:36:28 -0700
committerGravatar Tom Willemse2022-10-17 22:36:28 -0700
commit9e1202a67c4d68ff506c40b22d89b44b1c8d424b (patch)
tree0ca354eef70d1a1782947a97ee0f75fea5e900c6
parent6ceb2edf16574973dfd81ad93c8c75863a40f7c1 (diff)
downloadshutdown-rofi-master.tar.gz
shutdown-rofi-master.zip
Update the READMEHEADmaster
-rw-r--r--README.org14
1 files changed, 13 insertions, 1 deletions
diff --git a/README.org b/README.org
index d64bac9..aae9931 100644
--- a/README.org
+++ b/README.org
@@ -1,3 +1,15 @@
#+title: Shutdown Rofi
-A simple little script using Rofi to create a shutdown menu.
+A simple little script using [[https://github.com/davatorium/rofi][Rofi]] to create a shutdown menu.
+
+* Requirements
+
+This script needs Rofi to be installed. It also assumes that [[https://herbstluftwm.org/][herbstluftwm]] is used as the window manager for the =quit= and =reload= commands.
+
+* Installation
+
+Put the =shutdown-rofi= script anywhere in your =$PATH=.
+
+* Usage
+
+Run the =shutdown-rofi= script without arguments.