Skip to content

Commit 29b6e75

Browse files
committed
fix docs
1 parent a74a5a5 commit 29b6e75

File tree

4 files changed

+20
-22
lines changed

4 files changed

+20
-22
lines changed

.github/workflows/build.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Build for Standalone and Hosting
1+
name: Build
22

33
on:
44
push:
@@ -21,9 +21,8 @@ jobs:
2121
with:
2222
dotnet-version: '9.x'
2323

24-
- name: Run dotnet build ForEditing
25-
run: dotnet build ForEditing.fsproj
24+
- name: Run dotnet build --configuration Release
25+
run: dotnet build
26+
2627

27-
- name: Run dotnet build ForPublishing
28-
run: dotnet build ForPublishing.fsproj
2928

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
run: dotnet tool restore
3131

3232
- name: Build code to make xml file
33-
run: dotnet build ForPublishing.fsproj -c Release # see required xml tags: https://fsprojects.github.io/FSharp.Formatting/zero-to-hero.html#Generating-API-documentation
33+
run: dotnet build --configuration Release # see required xml tags: https://fsprojects.github.io/FSharp.Formatting/zero-to-hero.html#Generating-API-documentation
3434

3535
- name: copy README.md to Docs/index.md
3636
run: cp README.md Docs/index.md

.github/workflows/release-nuget.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919
dotnet-version: '9.x'
2020

2121
- name: dotnet build
22-
run: dotnet build ForPublishing.fsproj --configuration Release
22+
run: dotnet build --configuration Release
2323

2424
- name: Check version consistency of git tag and CHANGELOG.md
2525
# needs in fsproj:
@@ -41,6 +41,6 @@ jobs:
4141
- name: Push NuGet package to nuget.org
4242
run: |
4343
dotnet nuget push `
44-
./bin/Release/Rhino.Scripting.${{ github.ref_name }}.symbols.nupkg `
44+
./bin/Release/Rhino.Scripting.FSharp.${{ github.ref_name }}.symbols.nupkg `
4545
--api-key ${{ secrets.NUGET_API_KEY }} `
4646
--source https://api.nuget.org/v3/index.json

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![logo](https://raw.githubusercontent.com/goswinr/Rhino.Scripting.FSharp/main/Doc/logo.png)
1+
![logo](https://raw.githubusercontent.com/goswinr/Rhino.Scripting.FSharp/main/Docs/img/logo.png)
22

33
# Rhino.Scripting.FSharp
44

@@ -46,19 +46,18 @@ It passes it's input on as output. See [definition](https://github.com/goswinr/F
4646

4747
[goswinr.github.io/Rhino.Scripting.FSharp](https://goswinr.github.io/Rhino.Scripting.FSharp)
4848

49-
### License
50-
[MIT](https://raw.githubusercontent.com/goswinr/FsEx/main/LICENSE.txt)
51-
52-
### Change Log
49+
## Thread Safety
50+
While the main Rhino Document is officially not thread safe, this library can be used from any thread.\
51+
If running async this library will automatically marshal all calls that affect the UI to the main Rhino UI thread \
52+
and wait for switching back till completion on UI thread.\
53+
Modifying the Rhino Document from a background thread is actually OK as long as there is only one thread doing it.\
54+
The main reason to use this library async is to keep the Rhino UI and Fesh scripting editor UI responsive while doing long running operations.
5355

54-
`0.8.1`
55-
- align Plane API with Euclid library
56+
## Contributing
57+
Contributions are welcome even for small things like typos. If you have problems with this library please submit an issue.
5658

57-
`0.8.0`
58-
- align Line, Point3d and Vector3d API with Euclid library
59-
- referencing Rhino.Scripting 0.8.0
60-
61-
`0.5.0`
59+
### License
60+
[MIT](https://github.com/goswinr/Rhino.Scripting.FSharp/blob/main/LICENSE.md)
6261

63-
- first public release
64-
- referencing Rhino.Scripting 0.5.0
62+
### Changelog
63+
see [CHANGELOG.md](https://github.com/goswinr/Rhino.Scripting.FSharp/blob/main/CHANGELOG.md)

0 commit comments

Comments
 (0)