aboutsummaryrefslogtreecommitdiff
path: root/README.in
diff options
context:
space:
mode:
Diffstat (limited to 'README.in')
-rw-r--r--README.in9
1 files changed, 7 insertions, 2 deletions
diff --git a/README.in b/README.in
index 1b5515bb..a750e0f4 100644
--- a/README.in
+++ b/README.in
@@ -12,10 +12,14 @@ Contributing
------------
Contributions are more than welcome. Patches, feature requests, bug 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.
+- https://tippedjs.com
+- JQuery
+
Building
--------
Since guile is primarily a scripting language no explicit compilation step is required. Just run module/main.scm and the appropriate modules will be compiled (guile will tell you what it's doing). For building this README, run
@@ -24,3 +28,4 @@ Since guile is primarily a scripting language no explicit compilation step is re
Techical Details
----------------
- Internally all weeks start on sunday, which is repsenented as `0'.
+