From 8866a1484371330ce754dfa5c682a6d84aac8958 Mon Sep 17 00:00:00 2001 From: Goswin Rothenthal Date: Mon, 20 Jan 2025 21:55:38 +0100 Subject: [PATCH] fix readme --- CHANGELOG.md | 11 ++++++++--- README.md | 18 +++++++++++------- Src/PlugIn.fs | 14 ++++++++------ 3 files changed, 27 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5df1163..9811b9c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] -## [0.19.0] - 2024-12-15 +## [0.20.0] - 2025-01-20 +### Changed +- Updated to Fesh 0.20.0 + +## [0.19.0] - 2025-01-13 ### Changed - Updated to Fesh 0.19.0 @@ -33,8 +37,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed - first public release -[Unreleased]: https://github.com/goswinr/Fesh.Rhino/compare/0.19.0...HEAD -[0.16.3]: https://github.com/goswinr/Fesh.Rhino/compare/0.16.3...0.19.0 +[Unreleased]: https://github.com/goswinr/Fesh.Rhino/compare/0.20.0...HEAD +[0.20.0]: https://github.com/goswinr/Fesh.Rhino/compare/0.19.0...0.20.0 +[0.19.0]: https://github.com/goswinr/Fesh.Rhino/compare/0.16.3...0.19.0 [0.16.3]: https://github.com/goswinr/Fesh.Rhino/compare/0.16.2...0.16.3 [0.16.2]: https://github.com/goswinr/Fesh.Rhino/compare/0.16.1...0.16.2 [0.16.1]: https://github.com/goswinr/Fesh.Rhino/compare/0.13.0...0.16.1 diff --git a/README.md b/README.md index ebf497e..985e38b 100644 --- a/README.md +++ b/README.md @@ -20,22 +20,27 @@ As shown in my talk at [FSharpConf 2016](https://www.youtube.com/watch?v=ZY-bvZZ ![Screenshot](https://raw.githubusercontent.com/goswinr/Fesh.Rhino/main/Media/screen1.png) +## .NET 4.8 or .NET 7 ? +As long as [RhinoCommon](https://www.nuget.org/packages/rhinocommon#supportedframeworks-body-tab) is not targeted for .NET 7 this plugin only supports .NET Framework 4.8.\ +In Rhino use the command [SetDotNetRuntime](https://www.rhino3d.com/en/docs/guides/netcore/) to switch between .NET Framework and .NET Core. +If you are on the wrong runtime you will get an error message box when trying to load the plugin. + ## Installation + +### Food for Rhino + Install via Food for Rhino https://www.food4rhino.com/en/app/fesh .\ Or from inside Rhino via the `PackageManager` command, then search for `Fesh`.\ No admin rights should be needed for this installation. - - Then launch the editor with the command `Fesh`. -As long as [RhinoCommon](https://www.nuget.org/packages/rhinocommon#supportedframeworks-body-tab) is not targeted for .NET 7 this plugin only supports .NET Framework 4.8.\ -In Rhino use the command [SetDotNetRuntime](https://www.rhino3d.com/en/docs/guides/netcore/) to switch between .NET Framework and .NET Core. ### Manual Installation You can also build the plugin from this repository via `dotnet build`.\ Then drag and drop the file `Fesh.rhp` into Rhino.\ Then launch the editor with the command `Fesh`. +## Known Issues The editor might not load properly if you have already another plug-in loaded that uses an older version of `Fsharp.Core`.\ See this [issue](https://github.com/goswinr/Fesh.Rhino/issues/2.)\ Please report any issues you encounter. @@ -88,9 +93,8 @@ The main reason to use this editor in Async mode is to keep the Rhino UI and the The [Rhino.Scripting](https://github.com/goswinr/Rhino.Scripting) library can be used from any thread.\ If running async it will automatically marshal all calls that affect the UI to the main Rhino UI thread and wait for switching back till completion on UI thread. -### Changelog +## Changelog see [CHANGELOG.md](https://github.com/goswinr/Fesh.Rhino/blob/main/CHANGELOG.md) -### License +## License [MIT](https://github.com/goswinr/Fesh.Rhino/blob/main/LICENSE) - diff --git a/Src/PlugIn.fs b/Src/PlugIn.fs index ff50b49..6d425a9 100644 --- a/Src/PlugIn.fs +++ b/Src/PlugIn.fs @@ -75,12 +75,14 @@ module internal FeshApp = // fesh.Log.PrintfnAppErrorMsg "Please visit https://www.food4rhino.com/en/app/fesh" // fesh.Log.PrintfnAppErrorMsg $"Or use the Rhino command 'PackageManager' to update Fesh. There you can also enable auto-updates." // else - fesh.Log.PrintfnAppErrorMsg $"A newer version of Fesh is available: {v} , you are using {cv}" - fesh.Log.PrintfnAppErrorMsg "It will be installed automatically if you have auto-updates configured in the Rhino PackageManager." - fesh.Log.PrintfnAppErrorMsg "Alternatively you can download it from https://www.food4rhino.com/en/app/fesh" + fesh.Log.PrintfnAppErrorMsg $"A newer version of Fesh is available: {v} , you are using {cv}" + fesh.Log.PrintfnAppErrorMsg "If you have auto-updates configured in the Rhino PackageManager" + fesh.Log.PrintfnAppErrorMsg "it will be installed automatically after restarting Rhino." + fesh.Log.PrintfnAppErrorMsg "Use the Rhino command 'PackageManager' and there the 'Installed' tab to check your settings." + fesh.Log.PrintfnAppErrorMsg "Alternatively you can download it from https://www.food4rhino.com/en/app/fesh" with _ -> - fesh.Log.PrintfnInfoMsg "Could not check for updates on https://github.com/goswinr/Fesh.Rhino/tags .\r\nAre you offline?" + fesh.Log.PrintfnInfoMsg "Could not check for updates on https://www.food4rhino.com/en/app/fesh .\r\nAre you offline?" } |> Async.Start @@ -189,8 +191,8 @@ type FeshPlugin () = MessageBox.Show( [| "The Fesh.Rhino Plugin currently only works well with.NET Framework." - "A RhinoCommon target for .NET 7 or 8 is not available yet." - "It might crash with .NET 7 or 8." + "A RhinoCommon nuget targeting .NET 7 is not available yet." + "It might crash with .NET 7" "Please use the Rhino Command 'SetDotNetRuntime' to change to .NET Framework." |] |> String.concat Environment.NewLine, "Fesh.Rhino Plugin | .NET Framework needed", MessageBoxButton.OK,