aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid <dbphillipsnz@gmail.com>2014-05-25 14:46:42 +1200
committerDavid <dbphillipsnz@gmail.com>2014-06-06 20:30:37 +1200
commit458e96671f29590e3e9c9a616a5547ec35f37644 (patch)
tree2cb94953d037ebeb05478e9f0f542e6425a75d58
parent153dca70db4fdae32ec9e1e6e8fea69b3218bfa4 (diff)
downloadparamano-458e96671f29590e3e9c9a616a5547ec35f37644.tar.xz
Updated readme re. Makefile
-rw-r--r--README.md43
1 files changed, 9 insertions, 34 deletions
diff --git a/README.md b/README.md
index 29fc7fd..1a842aa 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,9 @@ 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.
-Personally, I don't test on any Linux distributions apart from Archlinux, but I see no reason it shouldn't work.
+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.
+
+Despite the software's name, it should work on other distros as well.
Runtime Dependencies
@@ -20,62 +22,35 @@ Due to KISS, I don't tend to use ./configure scripts for relatively small progra
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.
----
-
-**Important Note**
-
-Note that any parameters set here will be compiled into the programs.
-If you're installing to a temporary directory (e.g. building a package for a package manager) then don't set the prefix to the temporary directory as this will become hard-coded into the programs.
-Instead, set this when calling `make install`.
-
----
-
Here's a list:
* BINDIR to override default binary directory (`/usr/bin`) for trayfreq and trayfreq-set
-* PREFIX to prepend to BINDIR, LOCALE_DIR etc
+* 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`
* MAKE to override default make program `make`
* CC to override default compiler `gcc`
* TRAYFREQ_SET to override default trayfreq-set program of `PREFIX/BINDIR/trayfreq-set`
+* DESTDIR (only for `make install` -- see below)
-If you'd like a huge amount of debug information every time you run trayfreq or trayfreq-set, then set DEBUG to something, eg:
+If you'd like a huge amount of debug information on the tty every time you run trayfreq or trayfreq-set, then set DEBUG to something, eg:
make all DEBUG=yeah
-An example build line for a system with binaries in `/usr/bin`:
-
- make all
-
-
-Quick (extreme) example for nutty system with binaries at `/exec` and sudo `/exec/sodu`:
+Extreme example for nutty system with binaries at `/exec` and sudo `/exec/sodu`:
make all BINDIR=/exec SUDO=/exec/sodu
Installation
============
-If you're using ArchLinux, just jump over to the AUR, download and unpack the tarball, `cd` to the newly unpacked folder and run `makepkg`.
-
-For all other systems, you'll probably be compiling from source.
-In that case, `make install` will install the package, making the assumption that:
-
-* Binaries (trayfreq, trayfreq-set) will go in `/usr/bin`
-* Locale directory starts at `/usr/share/locale`
-* Your sysconfdir is `/etc` (can't currently be changed)
-* You're installing to `/`
-
-In general, a plain `make install` should work if you're installing straight to `/`, i.e. you're not building a package or anything.
+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 PREFIX=/path/to/package/temp/dir LOCALE_DIR=/usr/share/locale
+ make install DESTDIR=/path/to/package/temp/dir
This will prefix **all** paths with `/path/to/package/temp/dir` while installing.
-LOCALE_DIR has to be overridden due to the stripping of `/usr/` from it when manually setting a prefix.
-**Check the command lines as they go past.**
-Now's the time to check that everything's going to go in the right place.
Autostarting
------------