From 08279a8112c1d6dfbd59d449dc6ed305c22f278f Mon Sep 17 00:00:00 2001
From: Tamas Gal <himself@tamasgal.com>
Date: Tue, 22 Mar 2022 15:28:20 +0100
Subject: [PATCH] Update readme
---
{{cookiecutter.project_slug}}/README.rst | 30 ++++++++++++++++++++++++
1 file changed, 30 insertions(+)
diff --git a/{{cookiecutter.project_slug}}/README.rst b/{{cookiecutter.project_slug}}/README.rst
index 1fa7780..94e95e6 100644
--- a/{{cookiecutter.project_slug}}/README.rst
+++ b/{{cookiecutter.project_slug}}/README.rst
@@ -10,3 +10,33 @@
.. image:: https://git.km3net.de/examples/km3badges/-/raw/master/docs-latest-brightgreen.svg
:target: https://{{cookiecutter.gitlab_username}}.pages.km3net.de/{{cookiecutter.project_slug}}
+
+Installation
+~~~~~~~~~~~~
+
+It is recommended to first create an isolated virtualenvironment to not interfere
+with other Python projects::
+
+ git clone {{cookiecutter.gitlab_repo_path}}
+ cd {{cookiecutter.project_slug}}
+ python3 -m venv venv
+ . venv/bin/activate
+
+Install directly from the Git server via ``pip`` (no cloneing needed)::
+
+ pip install git+{{cookiecutter.gitlab_repo_path}}
+
+Or clone the repository and run::
+
+ make install
+
+To install all the development dependencies, in case you want to contribute or
+run the test suite::
+
+ make install-dev
+ make test
+
+
+---
+
+*Created with ``cookiecutter https://git.km3net.de/templates/python-project``*
--
GitLab