Skip to content

Commit 31affdd

Browse files
committed
Elaborate Windows & Mac support
Indicate experimental Windows support. Direct readers to the continuous integration file for build instructions. Ask for volunteers for the MacOSX support. Indicate the existing Apple Framework support. Fix broken links.
1 parent 6c68f84 commit 31affdd

File tree

3 files changed

+31
-6
lines changed

3 files changed

+31
-6
lines changed

.github/workflows/validate-build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ jobs:
5858
build/
5959
if: startsWith(matrix.os, 'window') == false
6060

61-
- name: Resolve C++ build dependencies (msvc toolchain)
61+
- name: Resolve C++ build dependencies (mingw-w64 toolchain)
6262
run: >-
6363
meson setup
6464
-Darmadillo-code:lapack=none

README.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@
77
Currently, this work is a *very* early work in progress. Refer to
88
https://github.com/MicroscPSF/MicroscPSF-Matlab for the reference implementation.
99

10-
## Quick start
11-
12-
### Ubuntu/Linux
10+
## Quick start on Ubuntu/Linux
1311

1412
Install the compiler toolchain and the BLAS/LAPACK library:
1513

@@ -53,10 +51,37 @@ ninja all
5351
sudo ninja install
5452
```
5553

54+
## Other operating system support
55+
56+
### Windows
57+
58+
The C++ library only offers experimental support on MSVC/MinGW toolchain. Please
59+
refer to the build instruction file for details: https://github.com/MicroscPSF/MicroscPSF-Cpp/blob/main/.github/workflows/validate-build.yml
60+
61+
### MacOSX
62+
63+
Mac provides a nice *Accelerate* LAPACK interface in the Apple Framework. The
64+
build system is capable of [automatically detecting the framework as build
65+
depdendency](https://mesonbuild.com/Dependencies.html#appleframeworks), so the
66+
library should be able to compile and run PSF simulation natively.
67+
68+
The project is looking for volunteers and incoming PRs to enable Mac support.
69+
70+
Wishlist:
71+
72+
- [X] Enable Bessel function support from 3rd party library #14 .
73+
74+
- [ ] Modify
75+
[meson.build](https://github.com/MicroscPSF/MicroscPSF-Cpp/blob/main/3rdparty/packagefiles/armadillo-code/meson.build#L19)
76+
to detect the Accelerate LAPACK interface in Apple Framework.
77+
78+
- [ ] Document the build options, i.e. `meson setup -Duse_boost=true -Darmadillo-code:lapack=framework build-for-macosx`
79+
5680
## Running the examples
5781

5882
First, follow the *Quick start* instructions to build the example app. Then, given the following microscope configurations in the screenshot...
59-
![MicroscPSF-Matlab GUI](https://www.ee.cuhk.edu.hk/~tblu/monsite/demos/fastPSF/gui.png)
83+
84+
![MicroscPSF-Matlab GUI](examples/gui.png)
6085

6186
... program the example C++ file at
6287
[examples/generate-psf.cpp](https://github.com/MicroscPSF/MicroscPSF-Cpp/blob/main/examples/generate-psf.cpp)
@@ -89,4 +114,4 @@ screenshot above.
89114
- The original ISO C++ proposal: https://wg21.link/p0226r1
90115
- GCC compiler support status: https://gcc.gnu.org/onlinedocs/libstdc++/manual/status.html#status.iso.2017
91116
- Clang support status: https://libcxx.llvm.org/Status/Cxx17.html
92-
- Clang support ticket: https://github.com/llvm/llvm-project/issues/99939
117+
- Clang support ticket: https://github.com/llvm/llvm-project/issues/99939

examples/gui.png

136 KB
Loading

0 commit comments

Comments
 (0)