Skip to content

Commit

Permalink
Merge pull request #16 from mschauer/patch-1
Browse files Browse the repository at this point in the history
  • Loading branch information
jpfairbanks committed Oct 22, 2021
2 parents 9039378 + 14f12e2 commit 6ab2160
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
[![codecov.io](http://codecov.io/github/JuliaGraphs/Graphs.jl/coverage.svg?branch=master)](http://codecov.io/github/JuliaGraphs/Graphs.jl?branch=master)
[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://juliagraphs.org/Graphs.jl/dev/)

**Project Status:** The Graphs project is a reboot of the now-archived LightGraphs
## Current Project Status

The Graphs project is a reboot of the now-archived LightGraphs
package, which remains available on GitHub at
[sbromberger/LightGraphs.jl](https://github.com/sbromberger/LightGraphs.jl). If
you don't need any new features developed since the fork, you can continue to
Expand All @@ -15,6 +17,18 @@ this repository, but the current code base is unrelated to the old Graphs code
and is derived purely from LightGraphs. To access the history of the old Graphs code,
you can start from [commit 9a25019](https://github.com/JuliaGraphs/Graphs.jl/commit/9a2501948053f60c630caf9d4fb257e689629041).

**Transition from LightGraphs to Graphs:**

LightGraphs and Graphs are functionally identical, still there are some steps involved making the change:

* Change `LightGraphs = "093fc24a-ae57-5d10-9952-331d41423f4d"` to `Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"` in your Project.toml.
* Update your `using` and `import` statements.
* Update your type constraints and other references to `LightGraphs` to `Graphs`.
* Increment your version number. Following semantic versioning, we suggest a patch release when no graphs or other `Graphs.jl`-objects can be passed through the API of your package by those depending on it, otherwise consider it a breaking release. "Passed through" entails created outside and consumed inside your package and vice versa.
* Tag a release.

## Overview

Graphs offers both (a) a set of simple, concrete graph implementations -- `Graph`
(for undirected graphs) and `DiGraph` (for directed graphs), and (b) an API for
the development of more sophisticated graph implementations under the `AbstractGraph`
Expand Down

0 comments on commit 6ab2160

Please sign in to comment.