Skip to content

Commit

Permalink
Set titles to MD standard #176
Browse files Browse the repository at this point in the history
  • Loading branch information
hcwinsemius committed Aug 25, 2024
1 parent aab623a commit 19ae36f
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
width=100 align="right">
</figure>

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)
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand All @@ -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
Expand Down

0 comments on commit 19ae36f

Please sign in to comment.