Skip to content

Commit 3785cfe

Browse files
committed
readme: move documentation info at the top + add badge
1 parent d69d16c commit 3785cfe

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
<p align="center">
66
<a href="https://opensource.org/licenses/BSD-2-Clause"><img src="https://img.shields.io/badge/License-BSD%202--Clause-green.svg" alt="License"/></a>
7+
<a href="https://simple-robotics.github.io/proxsuite/"><img src="https://img.shields.io/badge/docs-online-brightgreen" alt="Documentation"/></a>
78
<a href="https://github.com/Simple-Robotics/proxsuite/actions/workflows/ci-linux-osx-win-conda.yml"><img src="https://github.com/Simple-Robotics/proxsuite/actions/workflows/ci-linux-osx-win-conda.yml/badge.svg?branch=main" alt="CI - Linux/OSX/Windows - Conda"></a>
89
<a href="https://badge.fury.io/py/proxsuite"><img src="https://badge.fury.io/py/proxsuite.svg" alt="PyPI version" height="20"></a>
910
<a href="https://anaconda.org/conda-forge/proxsuite"><img src="https://anaconda.org/conda-forge/proxsuite/badges/version.svg" alt="Conda version" height="20"></a>
@@ -43,6 +44,10 @@ We are ready to integrate **ProxSuite** within other optimization ecosystems.
4344
**Proxsuite** is reliable and extensively tested, showing the best performances on the hardest problems of the literature.
4445
**Proxsuite** is supported and tested on Windows, Mac OS X, Unix and Linux.
4546

47+
## Documentation
48+
49+
The online **ProxSuite** documentation of the last release is available [here](https://simple-robotics.github.io/proxsuite/).
50+
4651
## Getting started
4752

4853
**ProxSuite** is distributed on many well-known package managers.
@@ -140,7 +145,3 @@ This chart above reports performance profiles of different solvers. It is classi
140145
## Installation procedure
141146

142147
Please follow the installation procedure [here](https://github.com/Simple-Robotics/proxsuite/blob/main/doc/5-installation.md).
143-
144-
## Documentation
145-
146-
The online **ProxSuite** documentation of the last release is available [here](https://simple-robotics.github.io/proxsuite/).

0 commit comments

Comments
 (0)