Skip to content

Commit

Permalink
Transfer from gdalle and update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gdalle committed Sep 25, 2023
1 parent 8a43175 commit e583b9a
Show file tree
Hide file tree
Showing 8 changed files with 374 additions and 88 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@
*.jl.mem
/Manifest.toml
/docs/build/
/docs/src/index.md
.vscode/
2 changes: 1 addition & 1 deletion CITATION.bib
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
@misc{GraphsOptim.jl,
author = {Guillaume Dalle, Aurora Rossi and contributors},
title = {GraphsOptim.jl},
url = {https://github.com/gdalle/GraphsOptim.jl},
url = {https://github.com/JuliaGraphs/GraphsOptim.jl},
version = {v0.1.0},
year = {2023},
month = {6}
Expand Down
22 changes: 18 additions & 4 deletions README.md
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!
Loading

0 comments on commit e583b9a

Please sign in to comment.