From c5a4ee6124407a8cabe8424bc8a91446c5244ad0 Mon Sep 17 00:00:00 2001 From: Daniel Schadt Date: Sat, 17 Oct 2026 13:02:24 +0200 Subject: update README --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 895c838..20f2572 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Fietsboek Python versions -[Website](https://fietsboek.org) — [Documentation](https://docs.fietsboek.org) +[Website](https://fietsboek.org) — [Documentation](https://docs.fietsboek.org) - [Repository](https://gitlab.com/dunj3/fietsboek) ([Mirror](https://codeberg.org/dunj3/fietsboek)) Fietsboek is a self-hostable sharing site for GPX track recordings with social features. The goal is to have an application like [MyTourbook][MyTourbook] that @@ -38,6 +38,10 @@ Setup instructions are in the Development ----------- +- Start redis: + + docker run --rm -p 6379:6379 redis + - Setup the environment: virtualenv .venv @@ -49,6 +53,7 @@ Development [documentation](https://docs.fietsboek.org/administration/configuration.html). - Initialize the database: + .venv/bin/fietsupdate update -c development.ini .venv/bin/alembic -c development.ini upgrade head - Serve the code: @@ -57,6 +62,16 @@ Development - Hack away! +The documentation also contains information for developers. In particular, the +rendered docstrings can be found there: +https://docs.fietsboek.org/developer/module/fietsboek.html. + +Issues +------ + +Issues are tracked in the Gitlab repository. You can also report them via email +to `''.join("f_i.e,t:s$b^o(e)k"[::2]) + "@kingdread.de"`. + License ------- -- cgit v1.2.3