Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Advice for transition #16

Merged
merged 4 commits into from
Oct 22, 2021
Merged

Advice for transition #16

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8e4255e
Advice for transition
mschauer Oct 20, 2021
20a2e2f
Update README.md
mschauer Oct 22, 2021
5d816c5
Update README.md
mschauer Oct 22, 2021
14f12e2
Update README.md
mschauer Oct 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
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