aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHeiko Bernloehr <Heiko.Bernloehr@FreeIT.de>2018-02-21 13:30:21 +0100
committerHeiko Bernloehr <Heiko.Bernloehr@FreeIT.de>2018-02-21 13:30:49 +0100
commitd02bdbf97a7b144bb60647d97922b4a018c486e4 (patch)
treee468ddb46083260de26b42f53863fd7768d0e709
parent61abee084ddbe0b578a7ab7b6f0d0534ecb18cfc (diff)
downloadvipeval-d02bdbf97a7b144bb60647d97922b4a018c486e4.tar.gz
vipeval-d02bdbf97a7b144bb60647d97922b4a018c486e4.zip
Update README.md
New links to freeit and github.
-rw-r--r--README.md16
1 files changed, 9 insertions, 7 deletions
diff --git a/README.md b/README.md
index bf81128..05e7125 100644
--- a/README.md
+++ b/README.md
@@ -4,21 +4,20 @@ vipeval is a backend service for ECS/ViP. It's running as a pure client i.e. the
* You need Ruby 2.1.x installed
* No database needed
-It's allowed to run multiple instances of vipeval. They work cuncurrently
+It's allowed to run multiple instances of vipeval. They work concurrently
on their ECS resources.
## Installation
-Just download
-[vipeval-master.tar.gz](https://git.freeit.de/vipeval/snapshot/vipeval-master.tar.gz)
-and unpack or clone via `git clone https://git.freeit.de/vipeval`.
+Just download vipeval package ([github zip][vipeval-master_github.zip], [freeit tgz][vipeval-master_freeit.tgz])
+and unpack or clone it from git repository ([github][github-repo], [freeit][freeit-repo]) via git clone.
## Configuration
-Change into `vipeval` directory. Edit `config/appcfg.yml` (see explanations
+Change into vipeval root directory. Edit `config/appcfg.yml` (see explanations
in config file). Normally you should only edit under `ecs:`.
## Running
### Running in foreground
-Change into `vipeval` directory and type:
+Change into vipeval root directory and type:
bundle exec rails console -e production
@@ -68,4 +67,7 @@ only read by him. Or read it from a file owned and readable by root:
ECS_PASSWORD=$(cat my_password_file) bundle exec ...
-
+[vipeval-master_freeit.tgz]: https://git.freeit.de/vipeval/snapshot/vipeval-master.tar.gz
+[vipeval-master_github.zip]: https://github.com/freeit/vip_evaluation_server/archive/master.zip
+[freeit-repo]: https://git.freeit.de/vipeval
+[github-repo]: https://github.com/freeit/vip_evaluation_server