summaryrefslogtreecommitdiff
path: root/Readme.md
diff options
context:
space:
mode:
authorstuebinm2023-11-14 02:25:10 +0100
committerstuebinm2023-11-14 21:38:36 +0100
commit02b29877f4988014d7be04e1cd9b6c1caeac9282 (patch)
treee0b0f0400bc4e3b325c1b609c847735c94dade0b /Readme.md
parente816bce69c7df9b54fb9a67a4c18c757fa46f571 (diff)
rewrite it in Haskell
Diffstat (limited to 'Readme.md')
-rw-r--r--Readme.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..9f57c61
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,14 @@
+# bahnhof.name
+
+This repository contains the sources for [bahnhof.name](https://bahnhof.name),
+a simple web server which gives helpful information about railway stations
+in Germany, from both static files & by querying osm for information which
+are harder/impossible to get via Open Data from DB AG directly.
+
+## A note on packaging
+
+Building and packaging this is generally simple as long as you use `cabal`;
+however, the `fuzzyfind` package seems a little out of date. Yet it compiles
+fine even with newer dependencies, so you may want to disregard its version
+bounds if that makes things easier for you. An example package done with Nix can
+be found on [my nixfiles](https://stuebinm.eu/git/nixfiles/tree/pkgs/overlay.nix).