Skip to content

Commit 72cab28

Browse files
authored
Remove warning from README (#529)
1 parent 15f05fb commit 72cab28

File tree

1 file changed

+24
-33
lines changed

1 file changed

+24
-33
lines changed

README.md

Lines changed: 24 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,35 @@
1-
# Please read: Convex.jl needs a new maintainer
2-
3-
Hi there! Convex.jl is an old Julia package that has had a number of maintainers
4-
and [contributors over the years](https://github.com/jump-dev/Convex.jl/graphs/contributors).
5-
Most typically, these have been procrastinating graduate students who work on
6-
Convex.jl instead of finishing their thesis. However, we can't all be students
7-
forever, and so is Convex.jl in need of a new maintainer.
8-
9-
Therefore, **Convex.jl is in maintenance mode.**
10-
11-
There are still a number of community members who can review and merge pull
12-
requests, but they will not be doing any active development.
13-
14-
If you would like to get involved and help revive Convex.jl:
15-
* Join the JuMP developer chatroom at [https://gitter.im/JuliaOpt/JuMP-dev](https://gitter.im/JuliaOpt/JuMP-dev)
16-
to say hi. If you have questions relating to Convex.jl, we may be able to help.
17-
* Start by making some small pull requests to fix any of the open issues.
18-
191
# Convex.jl
202

213
[![Build Status](https://github.com/jump-dev/Convex.jl/workflows/CI/badge.svg)](https://github.com/jump-dev/Convex.jl/actions?query=workflow%3ACI)
224
[![Coverage](https://codecov.io/gh/jump-dev/Convex.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/jump-dev/Convex.jl)
235
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://jump.dev/Convex.jl/stable)
246
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://jump.dev/Convex.jl/dev)
257

26-
**Convex.jl** is a [Julia](http://julialang.org) package for [Disciplined Convex Programming](http://dcp.stanford.edu/). Convex.jl can solve linear programs, mixed-integer linear programs, and DCP-compliant convex programs using a variety of solvers, including [Mosek](https://github.com/JuliaOpt/Mosek.jl), [Gurobi](https://github.com/jump-dev/Gurobi.jl), [ECOS](https://github.com/jump-dev/ECOS.jl), [SCS](https://github.com/jump-dev/SCS.jl), and [GLPK](https://github.com/JuliaOpt/GLPK.jl), through [MathOptInterface](https://github.com/jump-dev/MathOptInterface.jl). It also supports optimization with complex variables and coefficients.
8+
**Convex.jl** is a [Julia](http://julialang.org) package for
9+
[Disciplined Convex Programming](http://dcp.stanford.edu/) (DCP).
2710

28-
**Installation**: `julia> Pkg.add("Convex")`
11+
Convex.jl can solve linear programs, mixed-integer linear programs, and
12+
DCP-compliant convex programs using a variety of solvers, including
13+
[Mosek](https://github.com/MOSEK/Mosek.jl),
14+
[Gurobi](https://github.com/jump-dev/Gurobi.jl),
15+
[ECOS](https://github.com/jump-dev/ECOS.jl),
16+
[SCS](https://github.com/jump-dev/SCS.jl), and
17+
[GLPK](https://github.com/jump-dev/GLPK.jl), through
18+
[MathOptInterface](https://github.com/jump-dev/MathOptInterface.jl).
2919

30-
- **Detailed documentation and examples** for Convex.jl ([stable](https://jump.dev/Convex.jl/stable) | [development version](https://jump.dev/Convex.jl/dev)).
31-
- If you're running into **bugs or have feature requests**, please use the [Github Issue Tracker](https://github.com/jump-dev/Convex.jl/issues>).
32-
- For usage questions, please contact us via [Discourse](https://discourse.julialang.org/c/domain/opt).
20+
Convex.jl also supports optimization with complex variables and coefficients.
3321

34-
## Quick Example
22+
For usage questions, please contact us via [Discourse](https://discourse.julialang.org/c/domain/opt).
23+
24+
## Installation
3525

36-
To run this example, first install Convex and at least one solver, such as SCS:
3726
```julia
38-
using Pkg
27+
import Pkg
3928
Pkg.add("Convex")
40-
Pkg.add("SCS")
4129
```
42-
Now let's solve a least-squares problem with inequality constraints.
30+
31+
## Quick Example
32+
4333
```julia
4434
# Let us first make the Convex.jl module available
4535
using Convex, SCS
@@ -69,12 +59,15 @@ problem.optval
6959

7060
A number of examples can be found [here](https://jump.dev/Convex.jl/stable/).
7161
The [basic usage notebook](https://jump.dev/Convex.jl/stable/examples/general_examples/basic_usage/)
72-
gives a simple tutorial on problems that can be solved using Convex.jl. All examples can be downloaded as
73-
a zip file from [here](https://jump.dev/Convex.jl/stable/examples/notebooks.zip).
62+
gives a simple tutorial on problems that can be solved using Convex.jl.
63+
64+
All examples can be downloaded as a zip file from [here](https://jump.dev/Convex.jl/stable/examples/notebooks.zip).
7465

7566
## Citing this package
7667

77-
If you use Convex.jl for published work, we encourage you to cite the software using the following BibTeX citation:
68+
If you use Convex.jl for published work, we encourage you to cite the software
69+
using the following BibTeX citation:
70+
7871
```bibtex
7972
@article{convexjl,
8073
title = {Convex Optimization in {J}ulia},
@@ -86,5 +79,3 @@ If you use Convex.jl for published work, we encourage you to cite the software u
8679
primaryClass = "math-oc",
8780
}
8881
```
89-
90-
> Convex.jl was previously called CVX.jl.

0 commit comments

Comments
 (0)