Restructure README #2410
Merged
Restructure README #2410
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #2410 +/- ##
=======================================
Coverage 91.86% 91.86%
=======================================
Files 42 42
Lines 4463 4463
=======================================
Hits 4100 4100
Misses 363 363 Continue to review full report at Codecov.
|
mlubin
reviewed
Dec 14, 2020
| [Clp], [COSMO], [Couenne], [CPLEX], [CSDP], [ECOS], [FICO Xpress], [GLPK], | ||
| [Gurobi], [Ipopt], [Juniper], [MOSEK], [NLopt], [OSQP], [ProxSDP], [SCIP], | ||
| [SCS], [SDPA], [SDPT3], [SeDuMi], [Tulip]) for a variety of problem classes, including | ||
| **[linear programming]**, **[(mixed) integer programming]**, |
There was a problem hiding this comment.
If we're deleting these keywords from the README, we should add some as GitHub package topics for better searchability.
There was a problem hiding this comment.
Added keywords as Github package topics.
mlubin
approved these changes
Dec 14, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've always found the README quite dense. We should be off-loading information to the documentation or the
jump.devwebsite.This PR reduces the amount of text, makes it more explicit that users should use the community forum to get help, and explains who should be using the latest release and development versions.