From 58839eda784c326c89a7719a2b9e57839d24cb47 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexandre=20Rab=C3=A9rin?= Date: Sun, 31 May 2020 21:21:08 +0200 Subject: [PATCH] Write release notes for QuikGraph.Graphviz module. --- README.md | 6 +++-- RELEASE_NOTES.md | 27 ++++++++++++++++++- docs/index.md | 8 ++++-- .../QuikGraph.Graphviz.csproj | 22 ++++++++++++++- 4 files changed, 57 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4f20a54b2..91b5a4c37 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ | **Quality** | [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=quikgraph&metric=alert_status)](https://sonarcloud.io/dashboard?id=quikgraph) | | **Nugets** | [![Nuget Status](https://img.shields.io/nuget/v/quikgraph.svg)](https://www.nuget.org/packages/QuikGraph) QuikGraph | | | [![Nuget Status](https://img.shields.io/nuget/v/quikgraph.svg)](https://www.nuget.org/packages/QuikGraph.Serialization) QuikGraph.Serialization | +| | [![Nuget Status](https://img.shields.io/nuget/v/quikgraph.svg)](https://www.nuget.org/packages/QuikGraph.Graphviz) QuikGraph.Graphviz | | **License** | MS-PL | # QuikGraph @@ -19,9 +20,9 @@ QuikGraph comes with algorithms such as depth first search, breath first search, It was then updated to become YC.QuickGraph. -**This version** of QuickGraph, renamed **QuikGraph**, is a fork of YC.QuickGraph, and I tried to clean the Core of the library to provide it as a clean NuGet package using modern C# development (.NET Core). +**This version** of QuickGraph, renamed **QuikGraph**, is a fork of YC.QuickGraph, and I tried to clean the library to provide it as a clean NuGet packages using modern C# development (.NET Core). -The plan would be to fully clean the original library and all its non Core parts and unit test it more. +The plan is to to fully clean, fix issues of the original library and all its non Core parts, and improve it. --- @@ -63,6 +64,7 @@ QuikGraph is available on [NuGet](https://www.nuget.org) in several modules. - [QuikGraph](https://www.nuget.org/packages/QuikGraph) (Core) - [QuikGraph.Serialization](https://www.nuget.org/packages/QuikGraph.Serialization) +- [QuikGraph.Graphviz](https://www.nuget.org/packages/QuikGraph.Graphviz) ### Where to go next? diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 09b3c0346..117339e09 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -1,6 +1,6 @@ # Release notes -## What's new in 2.1.0 May 11 2020 +## What's new in 2.1.0 May 11 2020 and June 3 2020 ### QuikGraph @@ -15,6 +15,31 @@ #### Fixes: * Fix a security vulnerability regarding XML serialization on target .NET Framework 3.5. +### QuikGraph.GraphViz + +Rework the original QuickGraph.Graphviz module into QuikGraph.Graphviz. This make possible to use the QuikGraph to Dot bridge. + +#### Fixes: +* Fix the floating points formatting when converted to Dot (Invariant culture). +* Fix some implementation issues accross the library. +* Fix labels, comments, tooltips, records and ports escaping. +* Fix a lot of graph to Dot conversions issues (wrong properties, invalid formatting, typo, etc). + +#### Updates: +* Add all color representations equivalent to System.Drawing.Color or System.Windows.Media.Color to GraphvizColor. + +#### New: +* Add conversion extensions from System.Drawing.Font to GraphvizFont (and vice versa). + +### API Breaks +* Dot escape method has been replaced by DotEscapers helpers that handle various escaping scenarios and are static. +* Some public API breaks (but should remain simple to do a migration). + +#### Misc: +* Clean the library code. +* Fully document library including convenient links to official Graphviz documentation. +* Use JetBrains annotations all over the library as much as possible. + --- ## What's new in 2.0.0 February 16 2020 diff --git a/docs/index.md b/docs/index.md index cb53e4202..7242678de 100644 --- a/docs/index.md +++ b/docs/index.md @@ -19,9 +19,9 @@ QuikGraph comes with algorithms such as depth first search, breath first search, It was then updated to become YC.QuickGraph. -**This version** of QuickGraph, renamed **QuikGraph**, is a fork of YC.QuickGraph, and I tried to clean the Core of the library to provide it as a clean NuGet package using modern C# development (.NET Core). +**This version** of QuickGraph, renamed **QuikGraph**, is a fork of YC.QuickGraph, and I tried to clean the library to provide it as a clean NuGet packages using modern C# development (.NET Core). -The plan would be to fully clean the original library and all its non Core parts and unit test it more. +The plan is to to fully clean, fix issues of the original library and all its non Core parts, and improve it. You can find library sources on [GitHub](https://github.com/KeRNeLith/QuikGraph). @@ -45,4 +45,8 @@ QuikGraph is available on [NuGet](https://www.nuget.org) in several modules. PM> Install-Package QuikGraph.Serialization +[![Nuget Status](https://img.shields.io/nuget/v/quikgraph.svg)](https://www.nuget.org/packages/QuikGraph.Graphviz) [QuikGraph.Graphviz](https://www.nuget.org/packages/QuikGraph.Graphviz) + + PM> Install-Package QuikGraph.Graphviz + \ No newline at end of file diff --git a/src/QuikGraph.Graphviz/QuikGraph.Graphviz.csproj b/src/QuikGraph.Graphviz/QuikGraph.Graphviz.csproj index fbed5c1d2..5def97bd0 100644 --- a/src/QuikGraph.Graphviz/QuikGraph.Graphviz.csproj +++ b/src/QuikGraph.Graphviz/QuikGraph.Graphviz.csproj @@ -20,13 +20,33 @@ This package is the Graphviz subset of the original QuickGraph renamed QuikGraph and ported to .NET Core. Supported platforms: +- .NET Standard 1.3+ +- .NET Core 1.0+ - .NET Framework 3.5+ Supports Source Link true QuikGraph.Graphviz - ➟ Release 2.1.0 + ➟ Release 2.1.0 +Rework the original QuickGraph.Graphviz module into QuikGraph.Graphviz. This make possible to use the QuikGraph to Dot bridge. + +Fixes: +- Fix the floating points formatting when converted to Dot (Invariant culture). +- Fix some implementation issues accross the library. +- Fix labels, comments, tooltips, records and ports escaping. +- Fix a lot of graph to Dot conversions issues (wrong properties, invalid formatting, typo, etc). + +Updates: +- Add all color representations equivalent to System.Drawing.Color or System.Windows.Media.Color to GraphvizColor. + +New: +- Add conversion extensions from System.Drawing.Font to GraphvizFont (and vice versa). + +Misc: +- Clean the library code. +- Fully document library including convenient links to official Graphviz documentation. +- Use JetBrains annotations all over the library as much as possible. QuickGraph QuikGraph Graph Structure Algorithm C# .NET Serialization Graphviz