X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;ds=sidebyside;f=web%2Fmanual.md;h=1fde2953a5b4494e42c0ccc5a856228c2f85805e;hb=7031f4e380b429e9c0eea1b8e5484dabdbb12ae5;hp=b154b3919091ff6a897a45f0f333fba1be4875bc;hpb=3fd8d0567ae654aed7e97e832568d3e1b98e20a2;p=paraslash.git diff --git a/web/manual.md b/web/manual.md index b154b391..1fde2953 100644 --- a/web/manual.md +++ b/web/manual.md @@ -167,7 +167,7 @@ window. Appearance can be customized via themes. para_gui provides key-bindings for the most common server commands and new key-bindings can be added easily. -### para_fade ### +### para_mixer ### An alarm clock and volume-fader for OSS and ALSA. @@ -187,7 +187,7 @@ Requirements git clone git://git.tuebingen.mpg.de/osl cd osl && make && sudo make install && sudo ldconfig - sudo apt-get install autoconf libssl-dev help2man gengetopt m4 \ + sudo apt-get install autoconf libssl-dev m4 \ libmad0-dev libid3tag0-dev libasound2-dev libvorbis-dev \ libfaad-dev libspeex-dev libFLAC-dev libsamplerate-dev realpath \ libasound2-dev libao-dev libreadline-dev libncurses-dev \ @@ -203,6 +203,13 @@ code repository, execute git clone git://git.tuebingen.mpg.de/osl +- [lopsub](http://people.tuebingen.mpg.de/maan/lopsub/). The long +option parser for subcommands generates the command line and config +file parsers for all paraslash executables. Clone the source code +repository with + + git clone git://git.tuebingen.mpg.de/lopsub + - [gcc](ftp://ftp.gnu.org/pub/gnu/gcc) or [clang](http://clang.llvm.org). All gcc versions >= 4.2 are currently supported. Clang version 1.1 or newer should work as well. @@ -214,13 +221,6 @@ disto. On BSD systems the gnu make executable is often called gmake. during compilation require the _Bourne again shell_. It is most likely already installed. -- [gengetopt](ftp://ftp.gnu.org/pub/gnu/gengetopt/) is needed to -generate the C code for the command line parsers of all paraslash -executables. - -- [help2man](ftp://ftp.gnu.org/pub/gnu/help2man) is used to create -the man pages. - - [m4](ftp://ftp.gnu.org/pub/gnu/m4/). Some source files are generated from templates by the m4 macro processor. @@ -754,8 +754,8 @@ these commands. The image, lyrics, moods and playlists tables are all blob tables. Blob tables consist of three columns each: The identifier which is -a positive non-negative number that is auto-incremented, the name -(an arbitrary string) and the content (the blob). +a positive number that is auto-incremented, the name (an arbitrary +string) and the content (the blob). All blob tables support the same set of actions: cat, ls, mv, rm and add. Of course, _add_ is used for adding new blobs to the table @@ -1813,6 +1813,33 @@ Examples Development =========== +Contributing +------------ + +Paraslash is an open source project and contributions are +welcome. Here's a list of things you can do to help the project: + +- Report problems with building, installing or running the software. + In particular, test the experimental git branches ("next" and "pu"). + This helps to identify and fix problems before the code gets merged + and thus keeps the master branch as stable as possible. +- Proofread the documentation (manual, web pages, man pages, source + code documentation) and point out unclear or poorly written parts. If + you are a native English speaker you will easily find a lot of text + that could be improved. +- Run analysis tools (coverity, afl, sparse, etc.) and report issues + found by those tools. +- Suggest new features you would like to see implemented. +- Compile and test on your favorite architecture or operating + system. The code is tested only on a limited set of systems, so you + will probably encounter problems when building on different systems. +- Post about about paraslash on your blog or on social networks. +- Build and maintain Debian/RPM packages for your favorite distribution. + +Note that there is no mailing list, no bug tracker and no discussion +forum for paraslash. If you'd like to contribute, or have questions +about contributing, send email to Andre Noll . + Tools ----- @@ -1934,7 +1961,7 @@ Coding Style The preferred coding style for paraslash coincides more or less with the style of the Linux kernel. So rather than repeating what is -written [there](http://www.kernel.org/doc/Documentation/CodingStyle), +written [there](http://www.kernel.org/doc/Documentation/process/coding-style.rst), here are the most important points. - Burn the GNU coding standards.