X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=web%2Fmanual.md;h=f8d35e548791f2ab3325fc71336f075edd13095f;hp=15386134771c2921ecf840347e8179aecc374e1a;hb=f5cf47f2bc4bb76d0d21e2467c5846cade38558f;hpb=073076f4e54b35ee96cfab0c4a47b40126f24213 diff --git a/web/manual.md b/web/manual.md index 15386134..f8d35e54 100644 --- a/web/manual.md +++ b/web/manual.md @@ -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. @@ -1813,6 +1820,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 +1968,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.