Skip to content

Commit 9e71fb5

Browse files
authored
Update the README to the standard JuMP style (#35)
1 parent 9691bb4 commit 9e71fb5

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

README.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,32 @@
11
# ModelAnalyzer.jl
22

3-
Experimental package with analysis and debugging tools for JuMP and MOI.
4-
53
[![Build Status](https://github.com/jump-dev/ModelAnalyzer.jl/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/jump-dev/ModelAnalyzer.jl/actions?query=workflow%3ACI)
6-
74
[![codecov](https://codecov.io/gh/jump-dev/ModelAnalyzer.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/jump-dev/ModelAnalyzer.jl)
85

9-
[![dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://jump-dev.github.io/ModelAnalyzer.jl/dev/)
6+
[ModelAnalyzer.jl](https://github.com/jump-dev/ModelAnalyzer.jl) is an
7+
experimental package with analysis and debugging tools for JuMP and
8+
MathOptInterface.
9+
10+
## License
11+
12+
`ModelAnalyzer.jl` is licensed under the [MIT License](https://github.com/jump-dev/MultiObjectiveAlgorithms.jl/blob/main/LICENSE.md).
13+
14+
## Getting help
15+
16+
If you need help, please ask a question on the [JuMP community forum](https://jump.dev/forum).
17+
18+
If you have a reproducible example of a bug, please [open a GitHub issue](https://github.com/jump-dev/ModelAnalyzer.jl/issues/new).
19+
20+
## Installation
21+
22+
Install `ModelAnalyzer` using `Pkg.add`:
23+
24+
```julia
25+
import Pkg
26+
Pkg.add(; url = "https://github.com/jump-dev/ModelAnalyzer.jl")
27+
```
28+
29+
## Documentation
30+
31+
The [documentation for ModelAnalyzer.jl](https://jump.dev/ModelAnalyzer.jl/dev/)
32+
describes how to use the package.

0 commit comments

Comments
 (0)