Skip to content

Commit

Permalink
Update README (#82)
Browse files Browse the repository at this point in the history
  • Loading branch information
odow authored Apr 10, 2023
1 parent df4d9e5 commit 0832380
Showing 1 changed file with 20 additions and 17 deletions.
37 changes: 20 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,26 @@
# PolyJuMP
# PolyJuMP.jl

| **Build Status** |
|:----------------:|
| [![Build Status][build-img]][build-url] |
| [![Codecov branch][codecov-img]][codecov-url] |
[![Build Status](https://github.com/jump-dev/PolyJuMP.jl/workflows/CI/badge.svg?branch=master)](https://github.com/jump-dev/PolyJuMP.jl/actions?query=workflow%3ACI)
[![codecov](https://codecov.io/gh/jump-dev/PolyJuMP.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/jump-dev/PolyJuMP.jl)

PolyJuMP is an extension to [JuMP](https://github.com/jump-dev/JuMP.jl) for formulating and solving polynomial optimization problems. These problems can then be solved using [Sum of Squares Programming](https://github.com/jump-dev/SumOfSquares.jl).
[PolyJuMP.jl](https://github.com/jump-dev/PolyJuMP.jl) is a [JuMP](https://github.com/jump-dev/JuMP.jl)
extension for formulating and solving polynomial optimization problems.

## Documentation
These problems can then be solved using [SumOfSquares.jl](https://github.com/jump-dev/SumOfSquares.jl).

## License

`PolyJuMP.jl` is licensed under the [MIT license](https://github.com/jump-dev/PolyJuMP.jl/blob/master/LICENSE.md).

- [**STABLE**][docs-stable-url] — **most recently tagged version of [SumOfSquares](https://github.com/jump-dev/SumOfSquares.jl)' documentation.**
- [**LATEST**][docs-latest-url] — *in-development version of [SumOfSquares](https://github.com/jump-dev/SumOfSquares.jl)' documentation.*
## Installation

[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
[docs-latest-img]: https://img.shields.io/badge/docs-latest-blue.svg
[docs-stable-url]: https://jump.dev/SumOfSquares.jl/stable
[docs-latest-url]: https://jump.dev/SumOfSquares.jl/latest
Install `PolyJuMP` using `Pkg.add`:
```julia
import Pkg
Pkg.add("PolyJuMP")
```

## Documentation

[build-img]: https://github.com/jump-dev/PolyJuMP.jl/workflows/CI/badge.svg?branch=master
[build-url]: https://github.com/jump-dev/PolyJuMP.jl/actions?query=workflow%3ACI
[codecov-img]: http://codecov.io/github/jump-dev/PolyJuMP.jl/coverage.svg?branch=master
[codecov-url]: http://codecov.io/github/jump-dev/PolyJuMP.jl?branch=master
Documentation for `PolyJuMP.jl` is included in the
[documentation for SumOfSquares.jl](https://jump.dev/SumOfSquares.jl/stable).

0 comments on commit 0832380

Please sign in to comment.