aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHugo Hörnquist <hugo@lysator.liu.se>2022-08-01 01:16:22 +0200
committerHugo Hörnquist <hugo@lysator.liu.se>2022-08-01 01:18:47 +0200
commit860c066fe09981f09f7ba71ce270c4486b571872 (patch)
treecdcf044964a7c16f0b749d3e71ed241a015a6f86
parentChange JavaScript build system to esbuild. (diff)
downloadcalp-860c066fe09981f09f7ba71ce270c4486b571872.tar.gz
calp-860c066fe09981f09f7ba71ce270c4486b571872.tar.xz
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.
-rw-r--r--Makefile7
-rw-r--r--README81
-rw-r--r--README.in54
-rw-r--r--README.md74
4 files changed, 76 insertions, 140 deletions
diff --git a/Makefile b/Makefile
index 8a1d4d23..f8827603 100644
--- a/Makefile
+++ b/Makefile
@@ -34,7 +34,7 @@ LIMIT_FILES=$(LIMIT:%=--only %)
# Skip these files when testing
SKIP=--skip $(PWD)/tests/test/web-server.scm
-all: go_files README static $(LOCALIZATIONS)
+all: go_files static $(LOCALIZATIONS)
$(MAKE) -C doc/ref
XGETTEXT_FLAGS = --from-code=UTF-8 --add-comments --indent -k_
@@ -71,13 +71,10 @@ install: all
$(MAKE) -C static install
$(MAKE) -C system install
$(MAKE) -C doc/ref install
- install -m 644 -D -t $(DESTDIR)/usr/share/doc/calp README
+ install -m 644 -D -t $(DESTDIR)/usr/share/doc/calp README.md
install -m 755 -D -t $(DESTDIR)/usr/lib/calp/ scripts/tzget
install -m755 -D production-main $(DESTDIR)/usr/bin/calp
-README: README.in
- ./main text < README.in | sed "s/<<today>>/`date -I`/" > README
-
lcov.info: $(GO_FILES)
env DEBUG=0 tests/run-tests.scm --coverage=$@ $(if $(VERBOSE),--verbose) $(SKIP) $(LIMIT_FILES)
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 <hugo@lysator.liu.se>
-
-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
-
diff --git a/README.in b/README.in
deleted file mode 100644
index d0abb27e..00000000
--- a/README.in
+++ /dev/null
@@ -1,54 +0,0 @@
- CALP
- Hugo Hörnquist
- <<today>>
-
-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 <hugo@lysator.liu.se>
-
-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
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..8257f728
--- /dev/null
+++ b/README.md
@@ -0,0 +1,74 @@
+CALP
+====
+
+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 <hugo@lysator.liu.se>
+
+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.
+
+[TZ]: https://github.com/eggert/tz
+[TZLIC]: https://github.com/eggert/tz/blob/master/LICENSE
+[VDIR]: http://vdirsyncer.pimutils.org/en/latest/vdir.html