Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
goswinr committed Jan 20, 2025
1 parent 376178e commit 8866a14
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 16 deletions.
11 changes: 8 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!-- ![PackageManager](https://raw.githubusercontent.com/goswinr/Fesh.Rhino/main/Media/screenPackage.png) -->

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.
Expand Down Expand Up @@ -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)

14 changes: 8 additions & 6 deletions Src/PlugIn.fs
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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,
Expand Down

0 comments on commit 8866a14

Please sign in to comment.