aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0eeacda
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+Departure Boards Mod for Minetest
+=======
+
+This mod adds splitflap-style departure boards for minetest, meant for
+use with advtrains or digilines.
+
+### Digilines usage
+
+The board accepts a table with the following parameters
+
+* `dest`: Destination
+* `line`: Line name
+* `rem`: Remark
+* `m`, `s`: minutes and seconds of the departure time
+* `lbg`, `lfg`: background and foreground colors of the line name, respectively
+* `remcolor`: color of the remark text
+
+### Credits
+
+Copyright ⓒ 2023 gpcf <gpcf@gpcf.eu>. Licensed under AGPL v3.