aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHugo Hörnquist <hugo@lysator.liu.se>2020-08-03 12:53:58 +0200
committerHugo Hörnquist <hugo@lysator.liu.se>2020-08-03 12:53:58 +0200
commitd784256c29d87e26978b3f3656ceb7fc76fd7913 (patch)
treeecc9c5e2bb447f082775ae136bbbdcf99151f280
parentResolve (datetime instance) TODO with ./configure? (diff)
downloadcalp-d784256c29d87e26978b3f3656ceb7fc76fd7913.tar.gz
calp-d784256c29d87e26978b3f3656ceb7fc76fd7913.tar.xz
Update README with new build instructions.
-rw-r--r--Makefile5
-rw-r--r--README18
-rw-r--r--README.in9
3 files changed, 23 insertions, 9 deletions
diff --git a/Makefile b/Makefile
index 097629d9..00cbc560 100644
--- a/Makefile
+++ b/Makefile
@@ -12,7 +12,7 @@ GUILE_C_FLAGS = -Lmodule \
-Wmacro-use-before-definition -Warity-mismatch \
-Wduplicate-case-datum -Wbad-case-datum
-all: $(GO_FILES)
+all: $(GO_FILES) README
obj/%.scm.go: %.scm
@mkdir -p obj
@@ -29,5 +29,8 @@ install:
rsync -a static $(DESTDIR)/usr/share/calp/www
# TODO main, tzget
+README: README.in
+ ./main text < README.in | sed "s/<<today>>/`date -I`/" > README
+
test:
tests/run-tests.scm
diff --git a/README b/README
index 5e064250..ec74ed90 100644
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
CALP
Hugo Hörnquist
- 2020-07-17
+ 2020-08-03
Calp is primarily a program for loading calendar files (.ics's) from
drendering them in different formats. The goal is however to also
@@ -40,11 +40,17 @@ Standards and specifications
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
- ./main text < README.in | sed "s/2020-07-17/`date -I`/" > README
+ ./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.
+
+To actually compile the files, and render the documentation (at the
+time of writing only the README), run
+ make all
Techical Details
----------------
diff --git a/README.in b/README.in
index 773c4b94..53f906a0 100644
--- a/README.in
+++ b/README.in
@@ -28,8 +28,13 @@ Standards and specifications
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
- ./main text < README.in | sed "s/<<today>>/`date -I`/" > README
+ ./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.
+
+To actually compile the files, and render the documentation (at the time of writing only the README), run
+ make all
Techical Details
----------------