Skip to content

Update README #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
odow merged 2 commits into from
Apr 10, 2023
Merged

Update README #82

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea9f403
Update README
odow Apr 9, 2023
f934f53
Update README.md
odow Apr 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 20 additions & 17 deletions README.md
View file
Open in desktop
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).