From 860c066fe09981f09f7ba71ce270c4486b571872 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= Date: Mon, 1 Aug 2022 01:16:22 +0200 Subject: Change README to a markdown file. The self-formatted code was fancy, and it showed of part of our functionality. It was however cumbersome to keep the file updated, and pre-formatted text on webpages honestly doesn't look that good. The contents of the README are however unchanged in this commit. --- README | 81 ------------------------------------------------------------------ 1 file changed, 81 deletions(-) delete mode 100644 README (limited to 'README') diff --git a/README b/README deleted file mode 100644 index 23643d42..00000000 --- a/README +++ /dev/null @@ -1,81 +0,0 @@ -make[1]: Entering directory '/home/hugo/code/calp' -make[1]: Nothing to be done for 'go_files'. -make[1]: Leaving directory '/home/hugo/code/calp' - CALP - Hugo Hörnquist - 2022-03-04 - -Calp is primarily a program for loading calendar files (.ics's) from -drendering them in different formats. The goal is however to also -support fancy filtering, an edit server, and more. The currently -working frontends is the HTML-frontend, which have the two main -modes of a month-by-month in "week" view, or a table of a single -month, and the terminal frontend. The terminatend is mostly for -debugging purposes, but it's quite usable still. - -Configuration is set in ~/.config/calp/config.scm. Set at least -calendar-files with something like: - (set-config! 'calendar-files (glob "~/calendars/*")). -Both single calendar files, and vdir's are supported, see vdirsyncer -and ikhal. Then run - ./main --help -to see how to start the different modes. - -Contributing ------------- -Easiest is to open issues at https://github.com/HugoNikanor/calp. -But patches and the like can also be mailed to - -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. - -The zoneinfo data [TZ] is in the public domain [TZLIC]. - -Standards and specifications ----------------------------- -- RFC 5545 (iCalendar) -- RFC 6321 (xCal) -- RFC 7265 (jCal) -- Vdir Storage Format [VDIR] - -Building & Running ------------------- -Everything can be directly loaded due to Guile's auto-compilation. -However, two entry points are provided. -- `main', which sets up its own environment, and explicitly builds -all libraries before starting, and -- `production-main', which assumes that the environment already is -fine, and is the version which should be installed. - -The code can also be explicitly manually built, see the makefile. - -The environment/make variable GUILE can be set to another guile -binary, such as `guile3'. -Guild by defaults also uses this, but if a separate guild version is -explicitly required then the env/make var GUILD can be set (but this -shouldn't be needed). - -Techical Details ----------------- -- Internally all weeks start on sunday, which is repsenented as `0'. - -== The configuration system == -For all user provided variables a purpose built configuration system -is used. Thee module `(util config)` exposes the bindings -`define-config` along with `set-config` and `get-config`. The idea -behind this, instead of direct variables, is to make it clearer what -is part of the configurable environment, it allows a set! before the -point of definition, and it makes values constraints easier to -manage. - -References ----------- - -[TZ] https://github.com/eggert/tz -[TZLIC] https://github.com/eggert/tz/blob/master/LICENSE -[VDIR] http://vdirsyncer.pimutils.org/en/latest/vdir.html - -- cgit v1.2.3