update readme and fix CI problem with .NET SDK version (#103)

Author: chtenb

.editorconfig

@@ -209,3 +209,8 @@ dotnet_naming_symbols.private_internal_fields.applicable_kinds = field
 dotnet_naming_symbols.private_internal_fields.applicable_accessibilities = private, internal
 dotnet_naming_style.camel_case_underscore_style.required_prefix = _
 dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case
+
+# To avoid the scrollbar on the github homepage
+[Tutorial.cs]
+max_line_length = 100
+indent_size = 2

.github/workflows/linux-build.yml

@@ -21,10 +21,10 @@ jobs:
     - name: Install libgts
       run: sudo apt-get update && sudo apt-get install -y libgts-0.7-5
 
-    - name: Setup .NET
-      uses: actions/setup-dotnet@v3
+    - name: Setup .NET SDK
+      uses: actions/setup-dotnet@v4
       with:
-        dotnet-version: 8.0.x
+        dotnet-version: '8.0.x'
 
     - name: Setup Just
       uses: extractions/setup-just@v3

.github/workflows/nuget.org-linux.yml

@@ -22,10 +22,10 @@ jobs:
     - name: Install libgts
       run: sudo apt-get update && sudo apt-get install -y libgts-0.7-5
 
-    - name: Setup .NET
-      uses: actions/setup-dotnet@v3
+    - name: Setup .NET SDK
+      uses: actions/setup-dotnet@v4
       with:
-        dotnet-version: 8.0.x
+        dotnet-version: '8.0.x'
 
     - name: Setup Just
       uses: extractions/setup-just@v3

.github/workflows/nuget.org-windows.yml

@@ -17,6 +17,11 @@ jobs:
       with:
         fetch-depth: 0
 
+    - name: Setup .NET SDK
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: '8.0.x'
+
     - name: Add msbuild to PATH
       uses: microsoft/setup-msbuild@v1.0.2
 

.github/workflows/win-build.yml

@@ -1,5 +1,3 @@
-# This is a basic workflow to help you get started with Actions
-
 name: win-build
 
 # Controls when the action will run. Triggers the workflow on push or pull request
@@ -21,6 +19,11 @@ jobs:
       with:
         fetch-depth: 0
 
+    - name: Setup .NET SDK
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: '8.0.x'
+
     - name: Add msbuild to PATH
       uses: microsoft/setup-msbuild@v1.0.2
 

README-src.md

@@ -5,18 +5,19 @@ Graphviz.NetWrapper
 
 `Rubjerg.Graphviz` ships with precompiled Graphviz binaries to ensure the exact graphviz version is used that we have tested and to make deployment more predictable.
 The current version we ship is Graphviz 11.0.0.
-
-### Windows
-`Rubjerg.Graphviz` ships with a bunch of precompiled Graphviz dlls built for 64 bit Windows.
 This library is compatible with .NET Standard 2.0, but the nuget package only supports .NET5.0 and higher.
 The unit tests run on windows and linux against .NET Framework .NET 8.0.
 
+### Windows
+`Rubjerg.Graphviz` ships with the necessary Graphviz binaries and dependencies built for 64 bit Windows.
+
 ### Linux
-In the same vein as our windows build, we ship precompiled binaries to make sure that this library is deployed with the same binaries as we've tested it.
-However, we do not ship graphviz dependencies, you will have to installed those yourself, if you need them.
+In the same vein as our windows build, we ship Graphviz binaries to make sure that this library is deployed with the same binaries as we've tested it.
+However, we do not ship all the dependencies of Graphviz.
+You will have to make sure these are available on your system, if you need them.
 [Here is a list of all the graphviz dependencies.](https://packages.fedoraproject.org/pkgs/graphviz/graphviz/fedora-rawhide.html#dependencies)
 In practice you may not need all of those.
-In particular, if you only want to read graphs and e.g. run the DOT algorithm, libc and libz are enough.
+In particular, if you only want to read graphs and run the DOT layout algorithm, libc and libz are enough.
 To run our tests successfully you will also need libgts and libpcre2 (for the neato algorithm).
 For more details, check the dependencies of any graphviz binaries with `ldd`.
 

README.md

@@ -0,0 +1,6 @@
+{
+  "sdk": {
+    "version": "8.0.0",
+    "rollForward": "latestFeature"
+  }
+}

Rubjerg.Graphviz.Test/Tutorial.cs

@@ -82,5 +82,8 @@ check-diff:
 check-fixme:
     bash -c "! git grep 'FIX''NOW'"
 
-check-all: generate-readme normalize format check-diff check-fixme
+check-tutorial-width:
+    awk 'length($0) > 100 { print FILENAME ":" NR ": " $0; found=1 } END { exit found }' Rubjerg.Graphviz.Test/Tutorial.cs
+
+check-all: generate-readme normalize format check-diff check-fixme check-tutorial-width