Import a README file

This commit is contained in:
Pierre Pronchery 2016-08-15 17:20:59 +02:00
parent 7a88ea6387
commit d4b9a9276b
2 changed files with 33 additions and 1 deletions

32
README.md Normal file
View File

@ -0,0 +1,32 @@
DeforaOS Mixer
==============
About Mixer
-----------
Mixer is a volume control application for the DeforaOS desktop.
Compiling Mixer
----------------
Mixer depends on the following components:
* DeforaOS libDesktop
* DocBook-XSL (for the manual pages)
With GCC, this should then be enough to compile Mixer:
$ make
To install (or package) Mixer in a different location:
$ make DESTDIR="/staging/directory" PREFIX="/another/prefix" install
Documentation
-------------
Manual pages for each of the executables installed are available in the `doc`
folder. They are written in the DocBook-XML format, and need libxslt and
DocBook-XSL to be installed to be converted to either HTML or man file format.

View File

@ -3,4 +3,4 @@ version=0.2.0
config=h,sh
subdirs=data,doc,po,src
dist=COPYING,Makefile,config.h,config.sh
dist=COPYING,Makefile,README.md,config.h,config.sh