Unverified Commit 4debc43a authored by Giulio Romualdi's avatar Giulio Romualdi Committed by GitHub
Browse files

Add conda-forge references in the README.md

Showing with 23 additions and 12 deletions
+23 -12
# osqp-eigen
| [![c++14](https://img.shields.io/badge/standard-C++14-blue.svg?style=flat&logo=c%2B%2B)](https://isocpp.org) | [![License](https://img.shields.io/badge/license-LGPL-19c2d8.svg)](https://github.com/robotology/osqp-eigen/blob/master/LICENSE) | [![Code quality](https://api.codacy.com/project/badge/Grade/a73c260e38d949eabeecc424410d859c)](https://www.codacy.com/manual/GiulioRomualdi/osqp-eigen?utm_source=github.com&utm_medium=referral&utm_content=robotology/osqp-eigen&utm_campaign=Badge_Grade) | [![CI](https://github.com/robotology/osqp-eigen/workflows/C++%20CI%20Workflow/badge.svg)](https://github.com/robotology/osqp-eigen/workflows/C++%20CI%20Workflow/badge.svg) |
| :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: |
| | | | |
| General | [![c++14](https://img.shields.io/badge/standard-C++14-blue.svg?style=flat&logo=c%2B%2B)](https://isocpp.org) [![License](https://img.shields.io/badge/license-LGPL-19c2d8.svg)](https://github.com/robotology/osqp-eigen/blob/master/LICENSE) |
| :-------: | :----------------------------------------------------------: |
| **CI/CD** | [![Code quality](https://api.codacy.com/project/badge/Grade/a73c260e38d949eabeecc424410d859c)](https://www.codacy.com/manual/GiulioRomualdi/osqp-eigen?utm_source=github.com&utm_medium=referral&utm_content=robotology/osqp-eigen&utm_campaign=Badge_Grade) [![CI](https://github.com/robotology/osqp-eigen/workflows/C++%20CI%20Workflow/badge.svg)](https://github.com/robotology/osqp-eigen/workflows/C++%20CI%20Workflow/badge.svg) [![Azure](https://dev.azure.com/conda-forge/feedstock-builds/_apis/build/status/osqp-eigen-feedstock?branchName=master)](https://dev.azure.com/conda-forge/feedstock-builds/_build/results?buildId=341091&view=results)|
| **conda** | [![Conda Recipe](https://img.shields.io/badge/recipe-osqp--eigen-green.svg)](https://anaconda.org/conda-forge/osqp-eigen) [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/osqp-eigen.svg)](https://anaconda.org/conda-forge/osqp-eigen) [![Conda Version](https://img.shields.io/conda/vn/conda-forge/osqp-eigen.svg)](https://anaconda.org/conda-forge/osqp-eigen) [![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/osqp-eigen.svg)](https://anaconda.org/conda-forge/osqp-eigen) |
Simple C++ wrapper for [osqp](http://osqp.readthedocs.io/en/latest/index.html) library.
## Documentation
## 📚 Documentation
The documentation is available online at the accompanying [website](https://robotology.github.io/osqp-eigen).
## Dependeces
## 📄 Dependences
The project depends only on [`osqp`](http://osqp.readthedocs.io/en/latest/index.html) and [Eigen3](http://eigen.tuxfamily.org/index.php?title=Main_Page). Please install [Catch2](https://github.com/catchorg/Catch2) if you want to run the tests only for testing.
## Usage
1. Clone the repository
## 🛠️ Usage
### 📦 Install with conda (recommended)
You can easily the library with [`conda`](https://github.com/conda-forge/osqp-eigen-feedstock) using the following command
```
conda install -c conda-forge osqp-eigen
```
`conda` will automatically install [`osqp`](http://osqp.readthedocs.io/en/latest/index.html) and [Eigen3](http://eigen.tuxfamily.org/index.php?title=Main_Page).
### ⚙️ Build from source (advanced)
1. Clone the repository
```
git clone https://github.com/robotology/osqp-eigen.git
```
2. Build it
2. Build it
```
cd osqp-eigen
mkdir build
......@@ -34,7 +45,7 @@ The project depends only on [`osqp`](http://osqp.readthedocs.io/en/latest/index.
OsqpEigen_DIR=/path/where/you/installed/
```
## How to use the library
## 🖥️ How to use the library
**osqp-eigen** provides native `CMake` support which allows the library to be easily used in `CMake` projects.
**osqp-eigen** exports a CMake target called `OsqpEigen::OsqpEigen` which can be imported using the `find_package` CMake command and used by calling `target_link_libraries` as in the following example:
```cmake
......@@ -45,10 +56,10 @@ add_executable(example example.cpp)
target_link_libraries(example OsqpEigen::OsqpEigen)
```
## Bug reports and support
## 🐛 Bug reports and support
All types of [issues](https://github.com/robotology/osqp-eigen/issues/new) are welcome.
## License
## 📝 License
Materials in this repository are distributed under the following license:
> All software is licensed under the LGPL3 License. See [LICENSE](https://github.com/robotology/osqp-eigen/blob/master/LICENSE) file for details.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment