aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorHugo Hörnquist <hugo@lysator.liu.se>2022-03-04 01:50:46 +0100
committerHugo Hörnquist <hugo@lysator.liu.se>2022-03-06 11:37:32 +0100
commit1cc4d947524b4780f0055e62e152083982bbf186 (patch)
tree31f4667b8a0eb7a77563df1fe98460a5d6774613 /README
parentTests now use our local compiled files. (diff)
downloadcalp-1cc4d947524b4780f0055e62e152083982bbf186.tar.gz
calp-1cc4d947524b4780f0055e62e152083982bbf186.tar.xz
Allow explicit GUILE environment, document it.
The environment variable GUILE can now be set to override the guile version, which allows us to test the code with multiple versions/implementations. Also updates README to note these variables.
Diffstat (limited to 'README')
-rw-r--r--README32
1 files changed, 19 insertions, 13 deletions
diff --git a/README b/README
index ef1cb239..23643d42 100644
--- a/README
+++ b/README
@@ -1,6 +1,9 @@
+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
- 2020-08-03
+ 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
@@ -39,19 +42,22 @@ Standards and specifications
- RFC 7265 (jCal)
- Vdir Storage Format [VDIR]
-Building
---------
- ./configure
- ./main
-No explicit compilation is required for general usage, since Guile
-compiles
-files as they are needed. You do however have to run `./configure`
-before the first startup to set up some local variables and download
-the timezone db.
+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.
-To actually compile the files, and render the documentation (at the
-time of writing only the README), run
- make all
+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
----------------