Skip to content

Commit

Permalink
docs: fix README formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
rickstaa committed Jan 27, 2024
1 parent 28236fc commit 499ab98
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,15 @@
[![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

Please see the accompanying [documentation](https://rickstaa.dev/stable-gym) for information on installing and using this package.

## 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.

0 comments on commit 499ab98

Please sign in to comment.