diff --git a/README.md b/README.md index 430cab48..ffbac9af 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -[![tests](https://github.com/ghga-de/metldata/actions/workflows/unit_and_int_tests.yaml/badge.svg)](https://github.com/ghga-de/metldata/actions/workflows/unit_and_int_tests.yaml) +[![tests](https://github.com/ghga-de/metldata/actions/workflows/tests.yaml/badge.svg)](https://github.com/ghga-de/metldata/actions/workflows/tests.yaml) [![Coverage Status](https://coveralls.io/repos/github/ghga-de/metldata/badge.svg?branch=main)](https://coveralls.io/github/ghga-de/metldata?branch=main) # Metldata @@ -58,6 +58,7 @@ accessions are not violated, however, data might become unavailable. ## Installation + We recommend using the provided Docker container. A pre-build version is available at [docker hub](https://hub.docker.com/repository/docker/ghga/metldata): @@ -89,6 +90,7 @@ metldata --help ``` ## Configuration + ### Parameters The service requires the following configuration parameters: @@ -383,19 +385,20 @@ that is applied to the source events as explained above. ## Development + For setting up the development environment, we rely on the -[devcontainer feature](https://code.visualstudio.com/docs/remote/containers) of vscode +[devcontainer feature](https://code.visualstudio.com/docs/remote/containers) of VS Code in combination with Docker Compose. -To use it, you have to have Docker Compose as well as vscode with its "Remote - Containers" +To use it, you have to have Docker Compose as well as VS Code with its "Remote - Containers" extension (`ms-vscode-remote.remote-containers`) installed. -Then open this repository in vscode and run the command -`Remote-Containers: Reopen in Container` from the vscode "Command Palette". +Then open this repository in VS Code and run the command +`Remote-Containers: Reopen in Container` from the VS Code "Command Palette". This will give you a full-fledged, pre-configured development environment including: - infrastructural dependencies of the service (databases, etc.) -- all relevant vscode extensions pre-installed -- pre-configured linting and auto-formating +- all relevant VS Code extensions pre-installed +- pre-configured linting and auto-formatting - a pre-configured debugger - automatic license-header insertion @@ -407,9 +410,11 @@ if you update dependencies in the [`./pyproject.toml`](./pyproject.toml) or the [`./requirements-dev.txt`](./requirements-dev.txt), please run it again. ## License + This repository is free to use and modify according to the [Apache 2.0 License](./LICENSE). -## Readme Generation -This readme is autogenerate, please see [`readme_generation.md`](./readme_generation.md) +## README Generation + +This README file is auto-generated, please see [`readme_generation.md`](./readme_generation.md) for details.