X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=web%2Fmanual.md;h=efb72b1e345d2ec92b3479c0fe47976b09c39d3c;hp=b154b3919091ff6a897a45f0f333fba1be4875bc;hb=b6b571e6c6fb52207b11fc7833b272ec8cfa28bf;hpb=3f51ff6eb4d96c3fec996ae32a63c175d40cee88 diff --git a/web/manual.md b/web/manual.md index b154b391..efb72b1e 100644 --- a/web/manual.md +++ b/web/manual.md @@ -249,8 +249,11 @@ recognized. The mp3 tagger also needs this library for modifying you need libogg, libvorbis, libvorbisfile. The corresponding Debian packages are called `libogg-dev` and `libvorbis-dev`. -- [libfaad](http://www.audiocoding.com/). For aac files (m4a) you -need libfaad (`libfaad-dev`). +- [libfaad and mp4ff](http://www.audiocoding.com/). For aac files +(m4a) you need libfaad and libmp4ff (package: `libfaad-dev`). Note +that for some distributions, e.g. Ubuntu, mp4ff is not part of the +libfaad package. Install the faad library from sources (available +through the above link) to get the mp4ff library and header files. - [speex](http://www.speex.org/). In order to stream or decode speex files, libspeex (`libspeex-dev`) is required. @@ -754,8 +757,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 +1816,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 +1964,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.