Merge pull request #1039 from mwestphal/update_doc

Update Changelog and install doc

doc/CHANGELOG.md

@@ -2,17 +2,25 @@
 
 ## Ongoing development
 
+## v2.2.1
+
 For F3D users:
+ - Added a native Apple Silicon release package
  - Added new options `hdri-file`, `hdri-ambient`, `hdri-skybox` to have more control on the HDRI behavior
  - Added a default HDRI used when providing no `hdri-file`
  - Added bindings to toggle HDRI ambient lighting (`F`) and HDRI skybox (`J`)
  - Added bindings to move the camera to standard locations: `1`: Front, `3`: Right, `7`: Top, `9`: Isometric
  - Added [Open CASCADE BRep format](https://dev.opencascade.org/doc/overview/html/specification__brep_format.html) to the OCCT plugin.
+ - Fixed an infamous issue when the Windows thumbnailer always steal the focus
  - Fixed an issue with the binary release when opening draco files
  - Fixed an issue with matcap textures
  - Fixed an issue with HDRI lighting
  - Fixed an issue with HDRI lighting when dropping HDRI after a model
+ - Fixed an issue where invalid option would not show on Windows
+ - Fixed an issue where previously loaded file would stay visible
+ - Fixed an issue when loading invalid EXR file as HDRI
  - Fixed cheatsheet menu rendering under 'Drop File Instructor'
+ - Fixed raytracing rendering issues
  - Improved cheatsheet menu contrast for any background color
  - Improved overall text contrast for any background color
  - Improved performance when changing model and using a HDRI
@@ -29,6 +37,7 @@ For libf3d users:
 For developers:
  - Added a deprecation framework
  - Removed `F3D_TESTING_ENABLE_HDRI_TESTS` cmake option and merged it with `F3D_TESTING_ENABLE_LONG_TIMEOUT_TESTS`
+ - Added a Getting Started guide for beginners developers
 
 For F3D packagers:
  - Fixed compatibility with FreeBSD

doc/user/INSTALLATION.md

@@ -1,14 +1,15 @@
 # Installation
 
-## Current release packages (2.1.0)
+## Current release packages (2.2.1)
 
 | Platform | Files |
 | -------- | ----- |
-| Windows Installer | [F3D-2.1.0-Windows.exe](https://github.com/f3d-app/f3d/releases/download/v2.1.0/F3D-2.1.0-Windows-x86_64-raytracing.exe) |
-| Windows (Portable) | [F3D-2.1.0-Windows.zip](https://github.com/f3d-app/f3d/releases/download/v2.1.0/F3D-2.1.0-Windows-x86_64-raytracing.zip) |
-| MacOS | [F3D-2.1.0-macOS.dmg](https://github.com/f3d-app/f3d/releases/download/v2.1.0/F3D-2.1.0-macOS-x86_64-raytracing.dmg) |
-| Debian-based Package | [F3D-2.1.0-Linux.deb](https://github.com/f3d-app/f3d/releases/download/v2.1.0/F3D-2.1.0-Linux-x86_64-raytracing.deb) |
-| Linux (Portable) | [F3D-2.1.0-Linux.tar.xz](https://github.com/f3d-app/f3d/releases/download/v2.1.0/F3D-2.1.0-Linux-x86_64-raytracing.tar.xz) |
+| Windows Installer | [F3D-2.2.1-Windows.exe](https://github.com/f3d-app/f3d/releases/download/v2.2.1/F3D-2.2.1-Windows-x86_64-raytracing.exe) |
+| Windows (Portable) | [F3D-2.2.1-Windows.zip](https://github.com/f3d-app/f3d/releases/download/v2.2.1/F3D-2.2.1-Windows-x86_64-raytracing.zip) |
+| MacOS (Intel) | [F3D-2.2.1-macOS-x86_64.dmg](https://github.com/f3d-app/f3d/releases/download/v2.2.1/F3D-2.2.1-macOS-x86_64-raytracing.dmg) |
+| MacOS (Silicon) | [F3D-2.2.1-macOS-arm64.dmg](https://github.com/f3d-app/f3d/releases/download/v2.2.1/F3D-2.2.1-macOS-arm64.dmg) |
+| Debian-based Package | [F3D-2.2.1-Linux.deb](https://github.com/f3d-app/f3d/releases/download/v2.2.1/F3D-2.2.1-Linux-x86_64-raytracing.deb) |
+| Linux (Portable) | [F3D-2.2.1-Linux.tar.xz](https://github.com/f3d-app/f3d/releases/download/v2.2.1/F3D-2.2.1-Linux-x86_64-raytracing.tar.xz) |
 
 ## Alternatives
 
@@ -42,3 +43,4 @@ You can also find packages for the following repositories:
 
 - [FreeBSD](https://cgit.freebsd.org/ports/tree/graphics/f3d)
 - [Spack](https://packages.spack.io/package.html?name=f3d)
+- [pypi](https://pypi.org/project/f3d/)

doc/user/LIMITATIONS_AND_TROUBLESHOOTING.md

@@ -99,6 +99,10 @@ Your previous F3D installation is current being used to generate thumbnails, wai
 
 F3D is not signed by Apple yet so macOS shows this warning. To run F3D, right click on the app and click "open", then click "open" again to be able to run F3D.
 
+> Using the silicon binary release, I cannot find the raytracing feature or open exodus files
+
+F3D raytracing and exodus plugin are not working on macOS silicon yet, see this [issue](https://github.com/f3d-app/f3d/issues/976).
+
 > I'm unable to get coloring right with step files
 
-F3D on macOS does not support coloring on cells because of a [VTK issue](https://gitlab.kitware.com/vtk/vtk/-/issues/18969)
+F3D on macOS does not support coloring on cells because of a [VTK issue](https://gitlab.kitware.com/vtk/vtk/-/issues/18969).