Update the README file

This commit is contained in:
Pierre Pronchery 2020-01-13 02:02:31 +01:00
parent dd84ede29d
commit 1257324d62

View File

@ -6,6 +6,8 @@ About Mixer
Mixer is a volume control application for the DeforaOS desktop.
Mixer is part of the DeforaOS Project, found at https://www.defora.org/.
Documentation
-------------
@ -18,13 +20,31 @@ Compiling Mixer
Mixer depends on the following components:
* Gtk+ 2.4 or later, or Gtk+ 3.0 or later
* DeforaOS libDesktop
* an implementation of `make`
* gettext (libintl) for translations
* DocBook-XSL (for the manual pages)
With GCC, this should then be enough to compile Mixer:
With these installed, the following command should be enough to compile Mixer on
most systems:
$ make
The following command will then install Mixer:
$ make install
To install (or package) Mixer in a different location:
$ make clean
$ make PREFIX="/another/prefix" install
Mixer also supports `DESTDIR`, to be installed in a staging directory; for
instance:
$ make DESTDIR="/staging/directory" PREFIX="/another/prefix" install
On some systems, the Makefiles shipped can be re-generated accordingly thanks to
the DeforaOS configure tool.
@ -32,11 +52,7 @@ The compilation process supports a number of options, such as PREFIX and DESTDIR
for packaging and portability, or OBJDIR for compilation outside of the source
tree.
For instance, to install (or package) Mixer in a different location:
$ make DESTDIR="/staging/directory" PREFIX="/another/prefix" install
Distributing Panel
Distributing Mixer
------------------
DeforaOS Mixer is subject to the terms of the 2-clause BSD license. Please see