From c613d15e89e9ea765c785d0af2d8facda856fb73 Mon Sep 17 00:00:00 2001 From: reverend Date: Fri, 27 Nov 2020 07:57:56 +0100 Subject: [PATCH] Updated Readme --- Readme.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/Readme.md b/Readme.md index 4a4a90c..48f0ba6 100644 --- a/Readme.md +++ b/Readme.md @@ -22,7 +22,7 @@ Right now it depends on the following non-core Python 3 libraries. These can be * [django-widget-tweaks](https://github.com/jazzband/django-widget-tweaks) Tweak the form field rendering in templates, not in python-level form definitions. * [django-taggit](https://github.com/jazzband/django-taggit) A simpler approach to tagging with Django. - ### Bundled Dependencies +### Bundled Dependencies We also leverage some other great OpenSource projects' code. We bundle those in the distribution to obsolete the need to pull those files from monitored CDNs. * [OpenLayers](https://openlayers.org/) [6.4.3] OpenLayers makes it easy to put a dynamic map in any web page. It can display map tiles, vector data and markers loaded from any source. @@ -88,7 +88,9 @@ Run `django_lostplaces/managy.py collectstatic` and you should be ready to go. If you haven't already setup a django instance, see [django's documentation](https://docs.djangoproject.com/en/3.1/topics/install/). -After that, download the desired release (probably the latest one) [from the releases page](https://git.mowoe.com/reverend/lostplaces-backend/releases) and install it using `pip install --user name-of-the-file.tar.gz` +Afterwards, either +- download the desired release [from the releases page](https://git.mowoe.com/reverend/lostplaces-backend/releases) and install it using `pip install --user name-of-the-file.tar.gz` +- or install the latest release using `pip install django-lostplaces` *Note: You can run pip install without the --user flag, which will require root privileges and introduces potential security issues.* @@ -144,3 +146,7 @@ Before making the django instance public, you should tweak the config `settings. Run `django_lostplaces/manage.py collectstatic` you should be ready to go. + + +### Contact +If you run into any issues, have any questions or If you are interested in this project in general, feel free to get in touch with us via [reverend@reverend2048.de](mailto:reverend@reverend2048.de), we do speak English and German. \ No newline at end of file