From 499ab98b37e8a091d65ed33d7d070fd296f0d67b Mon Sep 17 00:00:00 2001 From: Rick Staa Date: Sat, 27 Jan 2024 19:55:19 +0100 Subject: [PATCH] docs: fix README formatting --- README.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a4ed77fc..491f6602 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,7 @@ [![Contributions](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](CONTRIBUTING.md) [![DOI](https://zenodo.org/badge/287501190.svg)](https://zenodo.org/badge/latestdoi/287501190) -A Python package that contains several [gymnasium environments](https://gymnasium.farama.org/) with positive definite cost functions, designed for compatibility with stable RL agents. It was initially created for the stable RL -algorithms in the [Stable Learning Control](https://github.com/rickstaa/stable-learning-control) package but can be -used with any RL agent requiring a **positive definite cost function**. For more information about stable -RL agents see the [Stable Learning Control documentation](https://rickstaa.dev/stable-learning-control). +A Python package that contains several [gymnasium environments](https://gymnasium.farama.org/) with positive definite cost functions, designed for compatibility with stable RL agents. It was initially created for the stable RL algorithms in the [Stable Learning Control](https://github.com/rickstaa/stable-learning-control) package but can be used with any RL agent requiring a **positive definite cost function**. For more information about stable RL agents see the [Stable Learning Control documentation](https://rickstaa.dev/stable-learning-control). ## Installation and Usage @@ -18,7 +15,7 @@ Please see the accompanying [documentation](https://rickstaa.dev/stable-gym) for ## Contributing -We use [husky](https://github.com/typicode/husky) pre-commit hooks and github actions to enforce high code quality. Before contributing to this repository, please check the [contribution guidelines](CONTRIBUTING.md). +We use [husky](https://github.com/typicode/husky) pre-commit hooks and github actions to enforce high code quality. Before contributing to this repository, please check the [contribution guidelines](CONTRIBUTING.md). > \[!NOTE]\ > We used [husky](https://github.com/typicode/husky) instead of [pre-commit](https://pre-commit.com/), which is more commonly used with Python projects. This was done because only some tools we wanted to use were possible to integrate the Please feel free to open a [PR](https://github.com/rickstaa/stable-gym/pulls) if you want to switch to pre-commit if this is no longer the case.