aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBenjamin Kellermann <Benjamin.Kellermann@mgm-sp.de>2016-02-21 12:12:02 +0100
committerBenjamin Kellermann <Benjamin.Kellermann@mgm-sp.de>2016-02-21 12:12:02 +0100
commitb52219f09bfe76a705a7f69c7720563f8dae57c5 (patch)
tree8acc815bd3da19a1d861bdd4eaca75a07acce5cc /README.md
parent7f466b65c6b0038d8265768e58932d2e1c009253 (diff)
Markdown sanitized (again)
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 23 insertions, 10 deletions
diff --git a/README.md b/README.md
index 56d63ba..2135f78 100644
--- a/README.md
+++ b/README.md
@@ -11,8 +11,6 @@ GNU AGPL v3 or higher (see file License)
* libgettext-ruby (for localization)
* gettext (for generating localization files)
-
-
# 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«
@@ -22,45 +20,57 @@ GNU AGPL v3 or higher (see file License)
4. You need .mo files in order to use localisations.
You have 2 possibilities:
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
```
- 2. 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.:
+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
+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
+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:
+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
SetEnv GIT_COMMITTER_NAME="$GIT_AUTHOR_NAME"
SetEnv GIT_COMMITTER_EMAIL="$GIT_AUTHOR_EMAIL"
```
-10. Try to open http://$YOUR_SERVER/check.cgi to check if your config seems to work.
+10. Try to open http://$YOUR_SERVER/check.cgi to check if your config
+ seems to work.
# Pimp your Installation
* If you want to create your own Stylesheet, you just have to put it in
@@ -68,6 +78,7 @@ GNU AGPL v3 or higher (see file License)
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/ .
@@ -79,6 +90,7 @@ GNU AGPL v3 or higher (see file 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/
@@ -86,8 +98,9 @@ GNU AGPL v3 or higher (see file License)
```
# Translators
-If you set $DUDLE_POEDIT_AUTO to your lang, poedit will launch automatically when building the application.
-E.g.:
+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