Skip to content

Commit aa4dac6

Browse files
docs: update readme for macos support (maplibre#44)
change opengl support for macos from "should be supported" to "not possible", since opengl is [deprecated](https://developer.apple.com/library/archive/documentation/GraphicsImaging/Conceptual/OpenGL-MacProgGuide/opengl_pg_concepts/opengl_pg_concepts.html) on macos, add note on MoltenVK for arm macos formatted with prettier ## Launch Checklist <!-- Thanks for the PR! Feel free to add or remove items from the checklist. --> - [x] Confirm **your changes do not include backports from Mapbox projects** (unless with compliant license) - if you are not sure about this, please ask! - [x] Briefly describe the changes in this PR. - [ ] Link to related issues. - [ ] Include before/after visuals or gifs if this PR includes visual changes. - [ ] Write tests for all new functionality. - [ ] Document any changes to public APIs. - [ ] Post benchmark scores. - [ ] Add an entry to `CHANGELOG.md` under the `## main` section. --------- Co-authored-by: Frank Elsinga <frank@elsinga.de>
1 parent 2e90a70 commit aa4dac6

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,23 @@ If no feature is specified, the crate will automatically select the platform-app
2525

2626
### Platform Support
2727

28-
The following platform and backend combinations are supported and tested in CI:
28+
The following platform and rendering-API combinations are supported and tested in CI:
2929

30-
| Platform | Vulkan | OpenGL | Metal |
31-
|-----------|--------|--------|-------|
32-
| Linux x86 | || |
33-
| Linux ARM | || |
34-
| macOS ARM | 🟨 | 🟨 | 🟨 |
30+
| Platform | Metal | Vulkan | OpenGL |
31+
| --------- | ----- | ------ | ------ |
32+
| Linux x86 | || |
33+
| Linux ARM | || |
34+
| macOS ARM | 🟨 | 🟨[^1] | |
3535

3636
<sub>
3737
✅ = IS supported and tested in CI
3838
🟨 = SHOULD be supported, but currently is not
3939
❌ = Not possible
4040
</sub>
4141

42+
[^1]: Vulcan support on macos is provided via MoltenVK. There is a slight performance overhead for this with little upsides. Both Metal and Vulcan run through the same extensive test suite upstream. You can use Vulcan if you find a bug in the Metal implementation until we have fixed it upstream.
43+
44+
4245
### Apt Packages
4346

4447
> [!NOTE]
@@ -67,17 +70,18 @@ sudo apt-get install -y mesa-vulkan-drivers glslang-dev
6770

6871
## Development
6972

70-
* This project is easier to develop with [just](https://github.com/casey/just#readme), a modern alternative to `make`.
73+
- This project is easier to develop with [just](https://github.com/casey/just#readme), a modern alternative to `make`.
7174
Install it with `cargo install just`.
72-
* To get a list of available commands, run `just`.
73-
* To run tests, use `just test`.
75+
- To get a list of available commands, run `just`.
76+
- To run tests, use `just test`.
7477

7578
### Compiling MapLibre Native
7679

7780
This crate relies on the MapLibre Native library, which is compiled as part of the build process:
78-
* if the `MLN_FROM_SOURCE` environment variable is set, the build script will compile the native library from that dir.
79-
* if this repo has been cloned, it will contain the `/maplibre-native` submodule, which will be used to compile the library. Make sure to run `git submodule update --init --recursive` to fetch the submodule.
80-
* if there is no `/maplibre-native` submodule, the build script assumes it is being run as a dependency, and will try to download the source into the `OUT_DIR`. Note that the first might take significant time to download and compile.
81+
82+
- if the `MLN_FROM_SOURCE` environment variable is set, the build script will compile the native library from that dir.
83+
- if this repo has been cloned, it will contain the `/maplibre-native` submodule, which will be used to compile the library. Make sure to run `git submodule update --init --recursive` to fetch the submodule.
84+
- if there is no `/maplibre-native` submodule, the build script assumes it is being run as a dependency, and will try to download the source into the `OUT_DIR`. Note that the first might take significant time to download and compile.
8185

8286
### MapLibre Native Dependency Management
8387

@@ -93,8 +97,8 @@ Join the `#maplibre-martin` slack channel at OSMUS -- automatic invite is at <ht
9397

9498
Licensed under either of
9599

96-
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
97-
* MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
100+
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
101+
- MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
98102
at your option.
99103

100104
### Contribution

0 commit comments

Comments
 (0)