From e79910dd0762825bcfd514e21567980584342fd6 Mon Sep 17 00:00:00 2001 From: vv221 Date: Fri, 3 Apr 2020 21:59:15 +0200 Subject: [PATCH] Add installation instructions --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c953617..d3834a6 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,27 @@ through links in the page menu. ## Installation -Up-to-date installation instructions can be found [on the project wiki]. +Right now, only installation of the current development version through git is +available. Alternatives will be proposed once we start releasing stable +versions. + +### Installation using git + +#### Requirements + +* `git` + +#### Latest development version + +Assuming the root directory of your DokuWiki installation is `/srv/dokuwiki`: +``` +DOKUWIKI_PATH=/srv/dokuwiki +REPO_URL=https://forge.dotslashplay.it/vv221/dokuwiki-childrenpages.git +git clone --branch master --depth 1 "$REPO_URL" "$DOKUWIKI_PATH/lib/plugins/childrenpages" +``` + +## Developers instructions + +Up-to-date installation instructions for developers can be found [on the project wiki]. [on the project wiki]: https://forge.dotslashplay.it/vv221/dokuwiki-childrenpages/-/wikis/home#installation-instructions