aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid <dbphillipsnz@gmail.com>2014-09-29 11:18:27 +1300
committerDavid <dbphillipsnz@gmail.com>2014-09-29 11:18:27 +1300
commit28bd34be4df2f5965e9de2d43498798eeaf93a9d (patch)
tree77e9945410a709f6a93cc7ad20d048858b2eccc9
parent397bcb9ffb969f93c427db13dec92ddc243c9406 (diff)
downloadparamano-28bd34be4df2f5965e9de2d43498798eeaf93a9d.tar.xz
Updated readme
-rw-r--r--README.md67
1 files changed, 26 insertions, 41 deletions
diff --git a/README.md b/README.md
index dc1ebd7..17beaf0 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,17 @@
What?
=====
+This is a fork of trayfreq. It provides two icons in your system tray; one for your battery and one for your CPU.
+Hover the mouse over each for information, or right click the CPU to switch governors and frequencies.
+Simple.
-This is a fork of trayfreq, intended to work on modern Linux systems.
-The original trayfreq wasn't compatible with Archlinux, due to the migration away from a `/proc/acpi` directory.
-I forked the project and got it working again.
-If you're using ArchLinux, just jump over to the [AUR page for this software](https://aur.archlinux.org/packages/trayfreq-archlinux) and install it that way.
+Installation
+------------
-For other distros, you'll likely want to install Paramano using your package manager, creating a package if one doesn't exist in your repositories.
+* [Paramano on the AUR](https://aur.archlinux.org/packages/paramano)
+* [Latest stable source package](http://phillid.tk/sources/paramano-0.60.tar.gz)
+* A Gentoo ebuild is provided in the `build/` directory
+* For other distros, you'll likely want to install Paramano using your package manager, creating a package if one doesn't exist in your distro's repositories.
Runtime Dependencies
--------------------
@@ -18,54 +22,35 @@ Runtime Dependencies
Building
========
Due to KISS, I don't tend to use ./configure scripts for relatively small programs.
-Instead, it's up to the user to check they have the right libraries.
The sort of parameters you might pass to a ./configure can instead be passed to make.
Here's a list:
* BINDIR to override default binary directory (`/usr/bin`) for paramano and paramano-set
* PREFIX to prefix all paths with something
-* LOCALE_DIR to override default of `/usr/share/locale`
-* SUDO to override default sudo program `/usr/bin/sudo`
+* SHAREDIR to override default of `/usr/share/`
+* LOCALEDIR to override default of `SHAREDIR/locale`
+* SUDO to override default sudo program `BINDIR/sudo`
* MAKE to override default make program `make`
* CC to override default compiler `gcc`
-* PARAMANO_SET to override default paramano-set program of `PREFIX/BINDIR/paramano-set`
+* PARAMANO_SET to override default paramano-set program of `BINDIR/paramano-set`
+* DEBUG can be set to anything to build a huge amount of debug output stuff into parmano and parmano-set
* DESTDIR (only for `make install` -- see below)
-If you'd like a huge amount of debug information on the tty every time you run paramano or paramano-set, then set DEBUG to something, eg:
-
- make all DEBUG=yeah
-
+FAQ
+===
+Changing the governor/frequency doesn't work!
+---------------------------------------------
+You need root permissions to change the governor or frequency.
+Paramano will detect if it's not being run as root, and attempt to use sudo to elevate any calls to `paramano-set` to root.
+However, this requires passwordless sudo access to `paramano-set`.
+Here is an example for the user `alice`:
-Extreme example for nutty system with binaries at `/exec` and sudo `/exec/sodu`:
-
- make all BINDIR=/exec SUDO=/exec/sodu
-
-
-Installation
-============
-A plain `make install` should work if you're installing straight to `/`, i.e. you're not building a package or anything.
-If you *are* building a package or installing to a special dir, then you might want something like this:
-
- make install DESTDIR=/path/to/package/temp/dir
-
-This will prefix **all** paths with `/path/to/package/temp/dir` while installing.
-
-Autostarting
-------------
-`make install` will copy a .desktop file to /etc/xdg/autostart, meaning that all xdg-compliant window managers should start it automatically when Bob logs in.
-Bob's WM starts these programs as root, thus he is fully able to change the governor.
-
-Alice uses a non-xdg-compliant WM (e.g. dwm) so paramano is run as the user `alice`.
-She doesn't have permission to write to the files under `/sys/` so paramano can't change the governor.
-Alice needs to make paramano run `paramano-set` through sudo.
-This can be done in the configuration file.
-Then, she also needs to give herself passwordless permission to run `paramano-set` through sudo:
-
-
- # ... (/etc/sudoers
+ # ... (/etc/sudoers)
alice ALL = NOPASSWD: /usr/bin/paramano-set
# ...
-Simple.
+This won't build under MinGW/This doesn't work on Windows
+-----------------------------
+Correct.