summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2020-01-26 09:09:00 +0100
committerDaniel Friesel <derf@finalrewind.org>2020-01-26 09:09:00 +0100
commite01a82b14f948332e1a674a3a764dc13ef5fca48 (patch)
treee787628d998a5f51d4b9bbc029c0c9b1c77066e6
parent1fff115bab4de7ff235f6d6a34ed73035152a24a (diff)
README: Slightly more detailed installation notes
-rw-r--r--README.md48
1 files changed, 40 insertions, 8 deletions
diff --git a/README.md b/README.md
index d6ae7ba..891a6e7 100644
--- a/README.md
+++ b/README.md
@@ -17,13 +17,45 @@ instance if you like, see the Setup notes below.
Dependencies
---
- * perl >= 5.10
- * Cache::File (part of the Cache module)
- * Geo::Distance
- * Mojolicious
- * Travel::Status::DE::DBWagenreihung >= 0.00
- * Travel::Status::DE::DeutscheBahn >= 2.03
- * Travel::Status::DE::IRIS >= 1.21
+ * perl >= 5.20
+ * carton or cpanminus
+ * build-essential
+ * git
+
+Installation
+---
+
+After installing the dependencies, clone the repository using git, e.g.
+
+```
+git clone https://git.finalrewind.org/db-fakedisplay
+```
+
+Make sure that all files (including `.git`, which is used to determine the
+software version) are readable by your www user, and follow the steps in the
+next sections.
+
+Perl Dependencies
+---
+
+db-infoscreen depends on a set of Perl modules which are documented in
+`cpanfile`. After installing the dependencies mentioned above, you can use
+carton or cpanminus to install Perl depenencies locally.
+
+In the project root directory (where `cpanfile` resides), run either
+
+```
+carton install
+```
+
+or
+
+```
+cpanm --installdeps .
+```
+
+and set `PERL5LIB=.../local/lib/perl5` before running index.pl or wrap it
+with `carton exec hypnotoad index.pl`.
Setup
---
@@ -57,6 +89,6 @@ System requirements
---
Resource requirements depend on usage. For a few requests per second, about
-50MB (150k inodes) cache and one or two CPU cores should be sufficient.
+200MB (600k inodes) cache and one or two CPU cores should be sufficient.
db-infoscreen typically needs 50MB RAM per worker process, though calculating
with 100MB per worker is recommended to leave a safety margin.