From 7fc0f17fb37326c86a83627b856a5b75f522c090 Mon Sep 17 00:00:00 2001 From: Robin Haberkorn Date: Wed, 13 Sep 2023 17:26:53 +0300 Subject: added LDoc documentation * gives a useful overview of everything supported right now * especially the type documentation is useful, as these things are not self-evident in Lua (because of dynamic typing). * The LDoc page can later be published as the Github pages of the project. This can even be done automatically by a Github action. However, we should first make sure that it's okay to publish the project before defending the thesis since Github pages will always be public even for private repositories. * Documentation of command-line parameters is lacking (TODO). * It may be possible to use types like "Stream(number)" to describe streams of numbers. The LDoc documentation mentions boxed types. Perhaps there can even be Streamable(number)? * We are also lacking good example programs and/or introductory material. --- Makefile | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'Makefile') diff --git a/Makefile b/Makefile index d91b265..a2fbffa 100644 --- a/Makefile +++ b/Makefile @@ -19,10 +19,15 @@ LDFLAGS += $(LUA_LDFLAGS) $(READLINE_LDFLAGS) $(JACK_LDFLAGS) \ # with the LuaJIT FFI interface: LDFLAGS += -rdynamic +.PHONY: all doc + all : applause applause : applause.o evdev.o $(CC) -o $@ $^ $(LDFLAGS) +doc: + ldoc . + clean: $(RM) *.o applause -- cgit v1.2.3