aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README21
1 files changed, 19 insertions, 2 deletions
diff --git a/README b/README
index d958cc27..11892857 100644
--- a/README
+++ b/README
@@ -24,13 +24,21 @@ repports, and other stuff should be sent to <hugo@lysator.liu.se>.
If you want to contribute something yourself, either see TODO.* for
things to do, or run `grep -RE 'TODO|NOTE'.
-Requirements
-------------
+Requirements & Dependencies
+---------------------------
For basic functionallity guile-2.2 or greater should be enough
(tested to work with guile-3.0). You do however need to supply your
own calendar files. I recommend vdirsyncer for fetching local copies
from all over the internet.
+For popups to work the JS library Tipped is also needed, which
+brings a transitive dependency on JQuery. The script `download-deps'
+fetches both into "good" places in the static sub-directory. Tipped
+[TIPPED] is used under Creative Commons BY 4.0 [CCBY], © staaky.
+JQuery is used in accordance to their license [JQUERY].
+
+The zoneinfo data [TZ] is in the public domain [TZLIC].
+
Building
--------
Since guile is primarily a scripting language no explicit
@@ -43,3 +51,12 @@ Techical Details
----------------
- Internally all weeks start on sunday, which is repsenented as `0'.
+
+References
+----------
+
+[TIPPED] https://github.com/staaky/tipped
+[CCBY] https://creativecommons.org/licenses/by/4.0/
+[JQUERY] https://github.com/jquery/jquery/blob/master/LICENSE.txt
+[TZ] https://github.com/eggert/tz
+[TZLIC] https://github.com/eggert/tz/blob/master/LICENSE