From 19ae36f03ba0333d8dab300d266d14e40d783a47 Mon Sep 17 00:00:00 2001 From: hcwinsemius Date: Sun, 25 Aug 2024 19:21:47 +0200 Subject: [PATCH] Set titles to MD standard #176 --- README.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 8086b9b..76352a0 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,7 @@ width=100 align="right"> -pyOpenRiverCam -============== +# pyOpenRiverCam [![PyPI](https://badge.fury.io/py/pyopenrivercam.svg)](https://pypi.org/project/pyopenrivercam) [![Conda-Forge](https://anaconda.org/conda-forge/pyopenrivercam/badges/version.svg)](https://anaconda.org/conda-forge/pyopenrivercam) @@ -47,8 +46,7 @@ If you wish to fund this or other work on features, please contact us at info@ra > **_compatibility:_** At this moment **pyorc** works with any video compatible with OpenCV as long as it has proper metadata. -Installation ------------- +## Installation To get started with **pyorc**, we recommend to setup a python virtual environment. We recommend using a Miniconda or Anaconda environment as this will ease installation, and will allow you to use all @@ -117,17 +115,14 @@ conda activate pyorc-dev pip install -e . ``` -Using pyorc ------------ +## Using pyorc To use **pyorc**, you can use the API for processing. A command-line interface is forthcoming pending funding. A manual is also still in the making. -Acknowledgement ---------------- +## Acknowledgement The first development of pyorc has been supported by the World Meteorological Organisation - HydroHub. -License -------- +## License **pyorc** is licensed under AGPL Version 3 (see [LICENSE](./LICENSE) file). **pyorc** uses the following libraries and software with said licenses. @@ -147,6 +142,7 @@ Project organisation . ├── README.md ├── LICENSE + ├── TRADEMARK.md ├── setup.py <- setup script compatible with pip ├── environment.yml <- YML-file for setting up a conda environment with dependencies ├── docs <- Sphinx documentation source code