aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDavid <dbphillipsnz@gmail.com>2014-04-30 12:21:07 +1200
committerDavid <dbphillipsnz@gmail.com>2014-04-30 12:21:07 +1200
commit45b90e44c616b3e484cdc379e33d002a2d6f3e64 (patch)
tree1f8e76113f8d02cf4cb33d5b948eb99b364dbf44 /README.md
parentb4c1c31723f638968c87e9fbacf49978d3832a8d (diff)
downloadparamano-45b90e44c616b3e484cdc379e33d002a2d6f3e64.tar.xz
Merged installation instructions into readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
index c2800b9..66f89a1 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,27 @@ What?
=====
This is a fork of trayfreq which is intended to work on modern Archlinux systems (it'll probably work on other systems too).
+
+
+
+Installation
+============
+The basic installation's standard:
+
+make install
+
+----------------------------------
+
+Autostarting
+------------
+`make install` will copy a .desktop file over to /etc/xdg/autostart, meaning that all xdg-compliant window managers should start it automatically when you log in.
+As far as I am aware, they start trayfreq as root, thus it is fully able to change the governor.
+
+Personally, I use a non-xdg-compliant WM (dwm) so trayfreq needs to be run with sudo in my xinitrc.
+To avoid having to enter my password each time the xinitrc is run, I added this rule to my `/etc/sudoers`:
+
+ # ... (/etc/sudoers
+ david ALL = NOPASSWD: /usr/bin/trayfreq
+ # ...
+
+Simple.