Write release notes.

KeRNeLith · May 12, 2020 · 4d3f4f6 · 4d3f4f6
1 parent a2288d1
commit 4d3f4f6
Show file tree

Hide file tree

Showing 10 changed files with 92 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ It contains several overlap removal and layout algorithms that allow various kin
 Based on the [GraphSharp](https://archive.codeplex.com/?p=graphsharp) library, it has be reworked add some improvements to it.
 
 Main features:
-- Several layout algorithms (FR, KK, ISOM, LinLog, Simple Tree, Circular, Sugiyama, Compound FDP).
+- Several layout algorithms (FR, KK, ISOM, LinLog, Simple Tree, Circular, Sugiyama, Compound FDP, Random).
 - Overlap removal algorithms (FSA or One Way FSA).
 - Customizable WPF controls for visualization.
 

diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,5 +1,53 @@
 # Release notes
 
+## What's new in 1.0.0 May 12 2020
+
+### GraphShape
+
+#### General:
+* Fully clean the library code.
+* Extend support of the library to .NET Framework 3.5+.
+* Extend support of the library to .NET Standard 2.0+.
+* Uniformize APIs and behaviors of algorithms implementations.
+
+#### Fixes:
+* Various fixes for layout algorithms implementations.
+* Various fixes across the library.
+
+#### Update:
+* Algorithm parameters classes are equatable.
+* Algorithm cancellation will stop run earlier if possible.
+
+#### New:
+* Add a Random layout algorithm implementation.
+
+#### API Breaks
+* Some public API breaks (but should remain simple to do a migration).
+* Replace .NET framework base structs (Point, Vector, Size, Rect and Thickness) by equivalent ones to support .NET Standard.
+* Some algorithm were not working well and has been removed (Sugiyama).
+* Rename EfficientSugiyama to Sugiyama.
+* Namespaces simplifications.
+
+#### Misc:
+* Use JetBrains annotations all over the library as much as possible.
+
+### GraphShape.Controls
+
+#### General:
+* Fully clean the library code.
+* Extend support of the library to .NET Framework 3.5+.
+* Remove dependency to WPFExtensions package.
+
+#### Fixes:
+* Fix async compute mode on GraphLayout control.
+* Fix handlers registrations/unregistrations.
+* Various fixes across the library.
+
+#### Misc:
+* Use JetBrains annotations all over the library as much as possible.
+
+---
+
 ## What's new in 0.1.0 March 9 2020
 
 This release is based on GraphSharp from CodePlex.

diff --git a/docs/docfx.json b/docs/docfx.json
@@ -17,7 +17,7 @@
       ],
       "dest": "api",
       "properties": {
-        "TargetFramework": "net40"
+        "TargetFramework": "netstandard2.0"
       },
       "disableGitFeatures": false,
       "disableDefaultFilter": false

diff --git a/docs/index.md b/docs/index.md
@@ -17,7 +17,7 @@ It contains several overlap removal and layout algorithms that allow various kin
 Based on the [GraphSharp](https://archive.codeplex.com/?p=graphsharp) library, it has be reworked add some improvements to it.
 
 Main features:
-- Several layout algorithms (FR, KK, ISOM, LinLog, Simple Tree, Circular, Sugiyama, Compound FDP).
+- Several layout algorithms (FR, KK, ISOM, LinLog, Simple Tree, Circular, Sugiyama, Compound FDP, Random).
 - Overlap removal algorithms (FSA or One Way FSA).
 - Customizable WPF controls for visualization.
 

diff --git a/samples/GraphShape.Optimization/GraphShape.Optimization.csproj b/samples/GraphShape.Optimization/GraphShape.Optimization.csproj
@@ -3,7 +3,6 @@
   <PropertyGroup>
     <TargetFrameworks>netcoreapp3.1</TargetFrameworks>
     <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
-    <UseWpf>true</UseWpf>
 
     <Title>GraphShape.Optimization</Title>
     <RootNamespace>GraphShape.Optimization</RootNamespace>
@@ -19,6 +18,7 @@
 
     <ApplicationIcon>..\..\docs\images\graphshape.ico</ApplicationIcon>
     <OutputType>WinExe</OutputType>
+    <UseWpf>true</UseWpf>
   </PropertyGroup>
 
   <!-- Targets defines -->

diff --git a/samples/GraphShape.Sample/GraphShape.Sample.csproj b/samples/GraphShape.Sample/GraphShape.Sample.csproj
@@ -3,7 +3,6 @@
   <PropertyGroup>
     <TargetFrameworks>net472</TargetFrameworks>
     <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
-    <UseWpf>true</UseWpf>
 
     <Title>GraphShape.Sample</Title>
     <RootNamespace>GraphShape.Sample</RootNamespace>
@@ -19,6 +18,7 @@
 
     <ApplicationIcon>..\..\docs\images\graphshape.ico</ApplicationIcon>
     <OutputType>WinExe</OutputType>
+    <UseWpf>true</UseWpf>
   </PropertyGroup>
 
   <!-- Targets defines -->

diff --git a/src/GraphShape.Controls/GraphShape.Controls.csproj b/src/GraphShape.Controls/GraphShape.Controls.csproj
@@ -17,7 +17,7 @@
 
     <Copyright>Copyright © 2019</Copyright>
     <Description>GraphShape is a .NET graph layout framework based on Graph#.
-It contains several layout algorithms that allow various kind of layouts (FR, KK, ISOM, LinLog, Simple Tree, Circular, Sugiyama, Compound FDP).
+It contains several layout algorithms that allow various kind of layouts (FR, KK, ISOM, LinLog, Simple Tree, Circular, Sugiyama, Compound FDP, Random).
 
 It also provide overlap removal algorithms such as FSA (or One Way FSA) algorithms.
 
@@ -30,14 +30,19 @@ Supports Source Link</Description>
 
     <IsPackable>true</IsPackable>
     <PackageId>GraphShape.Controls</PackageId>
-    <PackageReleaseNotes>➟ Release 0.1.0
-This package is a version of the original GraphSharp renamed GraphShape and using NET Core csproj.
+    <PackageReleaseNotes>➟ Release 1.0.0
+General:
+- Fully clean the library code.
+- Extend support of the library to .NET Framework 3.5+.
+- Remove dependency to WPFExtensions package.
 
-Remove references to embedded assemblies and use NuGet packages as replacement (QuikGraph and WPFExtensions).
+Fixes:
+- Fix async compute mode on GraphLayout control.
+- Fix handlers registrations/unregistrations.
+- Various fixes across the library.
 
-It has been split in multiple packages (GraphShape and GraphShape.Controls).
-
-This package should be seen as an alternative one to the old frozen GraphSharp from CodePlex.</PackageReleaseNotes>
+Misc:
+- Use JetBrains annotations all over the library as much as possible.</PackageReleaseNotes>
     <PackageTags>GraphSharp GraphShape Graph Layout Algorithm C# WPF Controls</PackageTags>
   </PropertyGroup>
 

diff --git a/src/GraphShape/Algorithms/OverlapRemoval/FSAAlgorithm.cs b/src/GraphShape/Algorithms/OverlapRemoval/FSAAlgorithm.cs
@@ -9,7 +9,7 @@
 namespace GraphShape.Algorithms.OverlapRemoval
 {
     /// <summary>
-    /// Fast Statistical Alignment algorithm (FSA).
+    /// Force-Scan Algorithm (FSA).
     /// </summary>
     /// <typeparam name="TObject">Object type.</typeparam>
     /// <typeparam name="TParameters">Algorithm parameters type.</typeparam>

diff --git a/src/GraphShape/Algorithms/OverlapRemoval/OneWayFSAAlgorithm.cs b/src/GraphShape/Algorithms/OverlapRemoval/OneWayFSAAlgorithm.cs
@@ -6,7 +6,7 @@
 namespace GraphShape.Algorithms.OverlapRemoval
 {
     /// <summary>
-    /// One way Fast Statistical Alignment algorithm (FSA).
+    /// One way Force-Scan Algorithm (FSA).
     /// </summary>
     /// <typeparam name="TObject">Object type.</typeparam>
     public class OneWayFSAAlgorithm<TObject> : FSAAlgorithm<TObject, OneWayFSAParameters>

diff --git a/src/GraphShape/GraphShape.csproj b/src/GraphShape/GraphShape.csproj
@@ -16,7 +16,7 @@
 
     <Copyright>Copyright © 2019</Copyright>
     <Description>GraphShape is a .NET graph layout framework based on Graph#.
-It contains several layout algorithms that allow various kind of layouts (FR, KK, ISOM, LinLog, Simple Tree, Circular, Sugiyama, Compound FDP).
+It contains several layout algorithms that allow various kind of layouts (FR, KK, ISOM, LinLog, Simple Tree, Circular, Sugiyama, Compound FDP, Random).
 
 It also provide overlap removal algorithms such as FSA (or One Way FSA) algorithms.
 
@@ -29,14 +29,33 @@ Supports Source Link</Description>
 
     <IsPackable>true</IsPackable>
     <PackageId>GraphShape</PackageId>
-    <PackageReleaseNotes>➟ Release 0.1.0
-This package is a version of the original GraphSharp renamed GraphShape and using NET Core csproj.
+    <PackageReleaseNotes>➟ Release 1.0.0
+General:
+- Fully clean the library code.
+- Extend support of the library to .NET Framework 3.5+.
+- Extend support of the library to .NET Standard 2.0+.
+- Uniformize APIs and behaviors of algorithms implementations.
 
-Remove references to embedded assemblies and use NuGet packages as replacement (QuikGraph).
+Fixes:
+- Various fixes for layout algorithms implementations.
+- Various fixes across the library.
 
-It has been split in multiple packages (GraphShape and GraphShape.Controls).
+Update:
+- Algorithm parameters classes are equatable.
+- Algorithm cancellation will stop run earlier if possible.
 
-This package should be seen as an alternative one to the old frozen GraphSharp from CodePlex.</PackageReleaseNotes>
+New:
+- Add a Random layout algorithm implementation.
+
+API Breaks
+- Some public API breaks (but should remain simple to do a migration).
+- Replace .NET framework base structs (Point, Vector, Size, Rect and Thickness) by equivalent ones to support .NET Standard.
+- Some algorithm were not working well and has been removed (Sugiyama).
+- Rename EfficientSugiyama to Sugiyama.
+- Namespaces simplifications.
+
+Misc:
+- Use JetBrains annotations all over the library as much as possible.</PackageReleaseNotes>
     <PackageTags>GraphSharp GraphShape Graph Layout Algorithm C#</PackageTags>
   </PropertyGroup>