From 6b4d7ad9408e099e61719313bcb5503900d6dadd Mon Sep 17 00:00:00 2001 From: Jonathan Koschnick <jonikoschnick@aol.de> Date: Mon, 27 Jan 2025 10:31:48 +0100 Subject: [PATCH] Update README.md Image kram + --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index d1edc79..afbeed1 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,37 @@ Use the built-in continuous integration in GitLab. *** +# image-viewer-ex + +This is an example project for the usage of `git` and gitlab for the organizatio of a software project. + +A simple example application is provided here along with information and example how to setup a gitlab repository/project. + +## How to setup +`git clone https://gitlab.uni-hannover.de/leichter/image-viewer-example.git` +`pip install -r requirements.txt` + +## How to run + +`python imgview.py` + +## How to contribute + + `git clone https://gitlab.uni-hannover.de/leichter/image-viewer-example.git` + + `git branch yourbranch` + + `git stage changed_files.py ...` + + `git commit -m "some commit message"` + +If needed prepare login information for the online repo. + `git push (--set-upstream origin yourbranch)` + +Follow with merge steps on gitlab. + + + # Editing this README When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. -- GitLab