From 3c2ca6beb9315817e155580e196054c58e43f740 Mon Sep 17 00:00:00 2001 From: Oscar Dowson Date: Wed, 28 May 2025 16:33:20 +1200 Subject: [PATCH] Update the README to the standard JuMP style --- README.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 84418fb..cff924c 100644 --- a/README.md +++ b/README.md @@ -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.