-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Transfer from gdalle and update docs
- Loading branch information
Showing
8 changed files
with
374 additions
and
88 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,4 +3,5 @@ | |
*.jl.mem | ||
/Manifest.toml | ||
/docs/build/ | ||
/docs/src/index.md | ||
.vscode/ |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,23 @@ | ||
# GraphsOptim | ||
|
||
<!-- [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://gdalle.github.io/GraphsOptim.jl/stable) --> | ||
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://gdalle.github.io/GraphsOptim.jl/dev) | ||
[![Build Status](https://github.com/gdalle/GraphsOptim.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/gdalle/GraphsOptim.jl/actions/workflows/CI.yml?query=branch%3Amain) | ||
[![Coverage](https://codecov.io/gh/gdalle/GraphsOptim.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/gdalle/GraphsOptim.jl) | ||
<!-- [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliagraphs.org/GraphsOptim.jl/stable) --> | ||
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliagraphs.org/GraphsOptim.jl/dev) | ||
[![Build Status](https://github.com/JuliaGraphs/GraphsOptim.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaGraphs/GraphsOptim.jl/actions/workflows/CI.yml?query=branch%3Amain) | ||
[![Coverage](https://codecov.io/gh/JuliaGraphs/GraphsOptim.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaGraphs/GraphsOptim.jl) | ||
[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle) | ||
|
||
A package for graph optimization algorithms that rely on mathematical programming. | ||
|
||
## Getting started | ||
|
||
This package is still experimental, which is why it is not yet registered. | ||
To install it, you need to use the GitHub URL: | ||
|
||
```julia | ||
using Pkg; Pkg.add(url="https://github.com/JuliaGraphs/GraphsOptim.jl") | ||
``` | ||
|
||
## Roadmap | ||
|
||
This package only contains a few algorithms, and we would like to add more. | ||
New contributors are always welcome: just pick a problem from [our roadmap issue](https://github.com/JuliaGraphs/GraphsOptim.jl/issues/14), open a pull request following the [guidelines](https://github.com/JuliaGraphs/GraphsOptim.jl/CONTRIBUTING.md), and we will help you get it merged! |
Oops, something went wrong.