Finalize JuMP README

[pulsipher]

This addresses the concerns of @odow raised in #311.

@odow: Any other concerns or suggestions?

[odow]

Let's wait for the preview. It's easy to miss things just looking at Markdown.

[codecov[bot]]

Codecov Report

Merging #312 (fef1625) into master (c280bf8) will not change coverage. The diff coverage is n/a.

:exclamation: Current head fef1625 differs from pull request most recent head d4d9244. Consider uploading reports for the commit d4d9244 to get more accurate results

@@           Coverage Diff           @@
##           master     #312   +/-   ##
=======================================
  Coverage   99.77%   99.77%           
=======================================
  Files          36       36           
  Lines        7099     7099           
=======================================
  Hits         7083     7083           
  Misses         16       16           

[odow]

The linter failed. Here are the errors:

  {"message": "[Google.Latin] Use 'for example' instead of 'e.g.,'.", "location": {"path": "docs/src/packages/InfiniteOpt.md", "range": {"start": {"line": 17, "column": 24}}}, "severity": "ERROR"}
  {"message": "[Google.Latin] Use 'for example' instead of 'e.g.,'.", "location": {"path": "docs/src/packages/InfiniteOpt.md", "range": {"start": {"line": 19, "column": 44}}}, "severity": "ERROR"}
  {"message": "[Google.Latin] Use 'for example' instead of 'e.g.,'.", "location": {"path": "docs/src/packages/InfiniteOpt.md", "range": {"start": {"line": 20, "column": 16}}}, "severity": "ERROR"}
  {"message": "[Google.Latin] Use 'for example' instead of 'e.g.,'.", "location": {"path": "docs/src/packages/InfiniteOpt.md", "range": {"start": {"line": 21, "column": 13}}}, "severity": "ERROR"}
  {"message": "[Google.Ordinal] Spell out all ordinal numbers ('1st') in text.", "location": {"path": "docs/src/packages/InfiniteOpt.md", "range": {"start": {"line": 22, "column": 3}}}, "severity": "ERROR"}
  {"message": "[Google.Units] Put a nonbreaking space between the number and the unit in '1s'.", "location": {"path": "docs/src/packages/InfiniteOpt.md", "range": {"start": {"line": 22, "column": 3}}}, "severity": "ERROR"}
  {"message": "[Google.Exclamation] Don't use exclamation points in text.", "location": {"path": "docs/src/packages/InfiniteOpt.md", "range": {"start": {"line": 27, "column": 32}}}, "severity": "ERROR"}
  {"message": "[Google.Exclamation] Don't use exclamation points in text.", "location": {"path": "docs/src/packages/InfiniteOpt.md", "range": {"start": {"line": 47, "column": 35}}}, "severity": "ERROR"}

[odow]

Here's the preview: https://jump.dev/JuMP.jl/previews/PR3343/packages/InfiniteOpt/

[pulsipher]

Ok, the latest commit should fix the linter problems

[odow]

Started a new doc build off jump-readme.

[odow]

I think we're safe to skip a doc rebuild with that last commit :smile:

[odow]

You could also change the opening sentence to

[InfiniteOpt.jl](https://github.com/infiniteopt/InfiniteOpt.jl) is a `JuMP` extension

[pulsipher]

@odow: anything else before I merge this?