Skip to content
This repository was archived by the owner on Oct 22, 2021. It is now read-only.

Commit 016dfd5

Browse files
visrmatbesancon
authored andcommitted
add docs link to README (#26)
I put the buttons on one line like in LightGraphs.jl, and added a doc badge. For those that tend to miss badges and just Ctrl+F doc, I also added links in the text.
1 parent f8b7f89 commit 016dfd5

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
# LightGraphsFlows
22

33
[![Build Status](https://travis-ci.org/JuliaGraphs/LightGraphsFlows.jl.svg?branch=master)](https://travis-ci.org/JuliaGraphs/LightGraphsFlows.jl)
4-
54
[![Coverage Status](https://coveralls.io/repos/github/JuliaGraphs/LightGraphsFlows.jl/badge.svg?branch=master)](https://coveralls.io/github/JuliaGraphs/LightGraphsFlows.jl?branch=master)
6-
75
[![codecov.io](http://codecov.io/github/JuliaGraphs/LightGraphsFlows.jl/coverage.svg?branch=master)](http://codecov.io/github/JuliaGraphs/LightGraphsFlows.jl?branch=master)
6+
[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://juliagraphs.github.io/LightGraphsFlows.jl/latest/)
87

98
Flow algorithms on top of [LightGraphs.jl](https://github.com/JuliaGraphs/LightGraphs.jl),
109
including `maximum_flow`, `multiroute_flow` and `mincost_flow`.
1110
See [Maximum flow problem](https://en.wikipedia.org/wiki/Maximum_flow_problem)
1211
for a detailed description of the problem.
1312

13+
Documentation for this package is available [here](https://juliagraphs.github.io/LightGraphsFlows.jl/latest/). For an overview of JuliaGraphs, see [this page](https://juliagraphs.github.io/).
14+
1415
## Usage
1516

1617
### Maxflow
@@ -102,4 +103,4 @@ demand[4,6] = 1
102103
capacity = ones(6,6)
103104

104105
flow = mincost_flow(g, capacity, demand, w, ClpSolver(), 5, 6)
105-
```
106+
```

0 commit comments

Comments
 (0)