aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Schadt <kingdread@gmx.de>2026-10-17 13:02:24 +0200
committerDaniel Schadt <kingdread@gmx.de>2026-10-17 13:02:24 +0200
commitc5a4ee6124407a8cabe8424bc8a91446c5244ad0 (patch)
tree6dc93f7920d69a0fb767cb554f542aed5746154e
parent790b4d85c18d850d2c1dde04b2b71762c76ffded (diff)
downloadfietsboek-c5a4ee6124407a8cabe8424bc8a91446c5244ad0.tar.gz
fietsboek-c5a4ee6124407a8cabe8424bc8a91446c5244ad0.tar.bz2
fietsboek-c5a4ee6124407a8cabe8424bc8a91446c5244ad0.zip
update README
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 895c838..20f2572 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@ Fietsboek
<img src="https://img.shields.io/pypi/pyversions/fietsboek" alt="Python versions">
</a>
-[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
-------