Improve the MacOS documentation #54
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I have tested on a MacOS with version 12.1, no XCode and no Rust installed. I followed these steps :
It worked first try without the need to pre-build manually the maplibre_apple library. |
Yes, i fixed that last week. No more need to compile it first :) |
maxammann
approved these changes
May 1, 2022
Drabble
commented
May 5, 2022
This file was mistakenly commited.
Drabble
commented
May 5, 2022
Drabble
commented
May 5, 2022
Co-authored-by: Max Ammann <max@maxammann.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I was confused when I looked at the building documentation in the mdbooks because the first section specified Linux but the command
cargo runcan be used on many platforms with the right Rustup toolchain target. I also think that thecargo buildcommand should be mentioned first instead ofcargo runas we are in the building documentation.I have extended the MacOS documentation with my experience trying to run it in XCode.
Finally I have moved the note about building in XCode that was written in the root README.md to the mdbooks. I think it helps keep the README cleaner. Also in my tests I was not required to pre-build the Rust application (as said in the note) but I will try again on a clean environment tomorrow.
This is my first contribution to the project, I am sorry in advance if I made something wrong and I would be very pleased if you can give me feedback so I don't make the same mistakes again.