From 66c8bbe0fc135fa0be13f5448371cdc3852a7dfc Mon Sep 17 00:00:00 2001 From: Benjamin Kellermann Date: Sun, 21 Feb 2016 12:06:30 +0100 Subject: Markdown sanitized --- README.md | 37 +++++++++++-------------------------- 1 file changed, 11 insertions(+), 26 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3be2221..56d63ba 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,11 @@ - +# Authors + * Benjamin Kellermann + * a lot of contributers of small code pieces -Author: - Benjamin Kellermann +# License +GNU AGPL v3 or higher (see file License) -License: - GNU AGPL v3 or higher - see file License - -## Requirements +# Requirements * ruby >=1.8 * git >=1.6.5 (preferred and default setting) or bzr * libgettext-ruby (for localization) @@ -17,7 +13,7 @@ License: -## Installation +# Installation 1. Place this application into a directory where cgi-scripts are evaluated. 2. If you want to change some configuration, state it in the file »config.rb« (see config_sample.rb for help) @@ -25,47 +21,39 @@ License: 3. The webserver needs the permission to write into the directory 4. You need .mo files in order to use localisations. You have 2 possibilities: - - a. Run this small script to fetch the files from the main server: - + 1. Run this small script to fetch the files from the main server: ```sh cd $DUDLE_INSTALLATION_PATH for i in locale/??; do wget -O $i/dudle.mo https://dudle.inf.tu-dresden.de/locale/`basename $i`/dudle.mo done ``` - b. Build them on your own. This requires gettext, libgettext-ruby-util, potool, and make to be installed. - + 2. Build them on your own. This requires gettext, libgettext-ruby-util, potool, and make to be installed. ```sh sudo aptitude install gettect libgettext-ruby-util potool make make ``` 5. In order to let access control work correctly, the webserver needs auth_digest support. It therefore may help to type: - ```sh sudo a2enmod auth_digest ``` 6. In order to get atom-feed support you need ruby-ratom to be installed. E.g.: - ```sh sudo aptitude install rubygems ruby-dev libxml2-dev zlib1g-dev sudo gem install ratom ``` 7. for RUBY 1.9 you need to add - ```sh SetEnv RUBYLIB $DUDLE_INSTALLATION_PATH ``` to your .htaccess 8. to make titles with umlauts working you need to set the encoding e.g. by adding - ```sh SetEnv RUBYOPT "-E UTF-8:UTF-8" ``` to your .htaccess 9. It might be the case, that you have to set some additional Variables in your .htaccess: - ```sh SetEnv GIT_AUTHOR_NAME="http user" SetEnv GIT_AUTHOR_EMAIL=foo@example.org @@ -74,13 +62,12 @@ License: ``` 10. Try to open http://$YOUR_SERVER/check.cgi to check if your config seems to work. -## Pimp your Installation +# Pimp your Installation * If you want to create your own Stylesheet, you just have to put it in the folder »$DUDLE_HOME_FOLDER/css/«. Afterwards you may config this one to be the default Stylesheet. Examples can be found here: https://dudle.inf.tu-dresden.de/css/ This is a bazaar repository as well, so you may branch it if you want… - ```sh cd $DUDLE_HOME_FOLDER/css bzr branch https://dudle.inf.tu-dresden.de/css/ . @@ -92,17 +79,15 @@ License: Examples can be found here: https://dudle.inf.tu-dresden.de/unstable/extensions/ which again are repositories ;--) e.g.: - ```sh cd $DUDLE_HOME_FOLDER/dudle/extensions/ bzr branch https://dudle.inf.tu-dresden.de/unstable/extensions/10_participate/ bzr branch https://dudle.inf.tu-dresden.de/unstable/extensions/symcrypt/ ``` -## Translators +# Translators If you set $DUDLE_POEDIT_AUTO to your lang, poedit will launch automatically when building the application. E.g.: - ```sh export DUDLE_POEDIT_AUTO=fr bzr pull -- cgit v1.2.3