From 5edfcfbd7ba752fe8e5990dfe4f184d85a063501 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dirk=20M=C3=BCller?= Date: Mon, 25 Nov 2024 11:59:10 +0100 Subject: [PATCH] Add README Co-authored-by: Dmitri Popov --- src/bci_build/package/git/README.md.j2 | 29 ++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 src/bci_build/package/git/README.md.j2 diff --git a/src/bci_build/package/git/README.md.j2 b/src/bci_build/package/git/README.md.j2 new file mode 100644 index 000000000..43db998ab --- /dev/null +++ b/src/bci_build/package/git/README.md.j2 @@ -0,0 +1,29 @@ +# {{ image.title }}: Git application container +{% include 'badges.j2' %} + + +## Description + +Git is a distributed version control system that tracks +versions of files. Git is primarily designed for controlling source code in collaborative software development. + + +## Usage + +This container provides the {{ image.publish_registry.vendor }} version of Git. + +Example of using Git container: + +```ShellSession +$ podman run {{ image.pretty_reference }} git help +``` + +As Git requires a repository, the container +does not explicitly set an entrypoint. This way, you can launch the container in +interactive mode to clone a repository and work on it. To avoid losing all your changes when exiting the container, use a persistent volume mount on launch. + +For more use cases and documentation, refer to the +[Git SCM documentation](https://git-scm.com/doc). + + +{% include 'licensing_and_eula.j2' %}