diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 23 insertions, 6 deletions
@@ -1,6 +1,21 @@ Fietsboek ========= +<a href="https://gitlab.com/dunj3/fietsboek/-/pipelines"> + <img src="https://img.shields.io/gitlab/pipeline-status/dunj3/fietsboek?branch=master" alt="Pipeline status"> +</a> +<a href="https://fietsboek.readthedocs.io"> + <img src="https://img.shields.io/readthedocs/fietsboek" alt="Documentation status"> +</a> +<a href="https://pypi.org/project/fietsboek/"> + <img src="https://img.shields.io/pypi/v/fietsboek" alt="PyPI version"> +</a> +<a href="https://www.gnu.org/licenses/agpl-3.0.en.html"> + <img src="https://img.shields.io/gitlab/license/dunj3/fietsboek" alt="License"> +</a> + +[Website](https://fietsboek.org) — [Documentation](https://docs.fietsboek.org) + 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 runs as a web-service and allows sharing and discovering of new tracks. @@ -13,10 +28,9 @@ features are still lacking. Installation ------------ -Setup instructions are in the documentation. You can either build it locally -using [Sphinx](https://www.sphinx-doc.org/), or view the generated version -online: https://docs.fietsboek.org/ -([mirror](https://fietsboek.readthedocs.io/)). +Setup instructions are in the +[documentation](https://docs.fietsboek.org/administration/installation.html) +([mirror](https://fietsboek.readthedocs.io/en/latest/administration/installation.html)). Development ----------- @@ -24,9 +38,12 @@ Development - Setup the environment: virtualenv .venv - .venv/bin/pip install -e '.[testing]' + .venv/bin/pip install poetry + .venv/bin/poetry install -- Adjust `development.ini` to your needs +- Adjust `development.ini` to your needs. Explanations of the configuration + options are in the + [documentation](https://docs.fietsboek.org/administration/configuration.html). - Initialize the database: .venv/bin/alembic -c development.ini upgrade head |