Skip to content

Update the README to the standard JuMP style #35

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 1 commit into from
May 28, 2025
Merged

Update the README to the standard JuMP style #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 27 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,32 @@
# ModelAnalyzer.jl

Experimental package with analysis and debugging tools for JuMP and MOI.

[![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)

[![codecov](https://codecov.io/gh/jump-dev/ModelAnalyzer.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/jump-dev/ModelAnalyzer.jl)

[![dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://jump-dev.github.io/ModelAnalyzer.jl/dev/)
[ModelAnalyzer.jl](https://github.com/jump-dev/ModelAnalyzer.jl) is an
experimental package with analysis and debugging tools for JuMP and
MathOptInterface.

## License

`ModelAnalyzer.jl` is licensed under the [MIT License](https://github.com/jump-dev/MultiObjectiveAlgorithms.jl/blob/main/LICENSE.md).

## Getting help

If you need help, please ask a question on the [JuMP community forum](https://jump.dev/forum).

If you have a reproducible example of a bug, please [open a GitHub issue](https://github.com/jump-dev/ModelAnalyzer.jl/issues/new).

## Installation

Install `ModelAnalyzer` using `Pkg.add`:

```julia
import Pkg
Pkg.add(; url = "https://github.com/jump-dev/ModelAnalyzer.jl")
```

## Documentation

The [documentation for ModelAnalyzer.jl](https://jump.dev/ModelAnalyzer.jl/dev/)
describes how to use the package.
Loading