From 490bd9551dc37e2b767776fa131b6ca8c79bb694 Mon Sep 17 00:00:00 2001 From: Martin d'Allens Date: Tue, 17 Oct 2023 23:41:01 +0200 Subject: [PATCH] Fix some inconsistencies and typos in docs and comments (#1773) --- CONTRIBUTING.md | 2 +- DEVELOPING.md | 2 +- README.md | 8 ++++---- include/mbgl/renderer/renderer_frontend.hpp | 2 +- platform/android/DEVELOPING.md | 1 + platform/node/DEVELOPING.md | 10 ---------- platform/node/README.md | 1 - 7 files changed, 8 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b7936f8684e..cc8f58475d5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,7 +37,7 @@ If you want to contribute code: 4. Prefix your commit messages with the platform(s) your changes affect, e.g. `[ios]`. -Please note the special instructions for contributing new source code files, asset files, or user-facing strings to MapLibre Native for [iOS](platform/ios/CONTRIBUTING.md), [Android](platform/android/DEVELOPING.md) or [macOS](platform/ios/platform/macos/DEVELOPING.md). +Please note the special instructions for contributing new source code files, asset files, or user-facing strings to MapLibre Native for [iOS](platform/ios/CONTRIBUTING.md), [Android](platform/android/DEVELOPING.md) or [macOS](platform/macos/DEVELOPING.md). ## Design Proposals diff --git a/DEVELOPING.md b/DEVELOPING.md index b1cdb2816c5..6938b5ff409 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -18,7 +18,7 @@ To check that the output of the rendering is correct, we compare actual rendered The directory sturcture of the render tests looks like: ``` -maetrics/ +metrics/ integration/ render-tests/ / diff --git a/README.md b/README.md index 4ff96062e03..2efaf779d57 100644 --- a/README.md +++ b/README.md @@ -20,14 +20,14 @@ The documentation of MapLibre Native is a work in progress. To get an architectu ## Platforms -- [⭐️ Android](platform/android/README.md) -- [⭐️ iOS](platform/ios/platform/ios/README.md) +- [⭐️ Android](platform/android/README.md) +- [⭐️ iOS](platform/ios/README.md) - [GLFW](platform/glfw) - [Linux](platform/linux/README.md) - [Node.js](platform/node/README.md) - [Qt](platform/qt/README.md) - [Windows](platform/windows/README.md) -- [macOS](platform/ios/platform/macos/README.md) +- [macOS](platform/macos/README.md) Platforms with a ⭐️ are **MapLibre Core Projects** and have a substantial amount of financial resources allocated to them. Learn about the different [project tiers](https://github.com/maplibre/maplibre/blob/main/PROJECT_TIERS.md#project-tiers). @@ -48,7 +48,7 @@ To contribute to MapLibre Native, see [`CONTRIBUTING.md`](CONTRIBUTING.md) and ( ### Getting Involved -Join the `#maplibre-native` Slack channel at OSMUS. Get an invite at https://slack.openstreetmap.us/ +Join the `#maplibre-native` Slack channel at OSMUS. Get an invite at https://slack.openstreetmap.us/ ### Bounties 💰 diff --git a/include/mbgl/renderer/renderer_frontend.hpp b/include/mbgl/renderer/renderer_frontend.hpp index 3c9fb82181b..74e064ed185 100644 --- a/include/mbgl/renderer/renderer_frontend.hpp +++ b/include/mbgl/renderer/renderer_frontend.hpp @@ -8,7 +8,7 @@ class RendererObserver; class UpdateParameters; /// The RenderFrontend is the bridge between the Map and -/// platform used to update and observer the Renderer +/// platform used to update and observe the Renderer /// /// It hides any threading specifics and always replies on /// the original thread. diff --git a/platform/android/DEVELOPING.md b/platform/android/DEVELOPING.md index 6593a472eec..0e0135af1b7 100644 --- a/platform/android/DEVELOPING.md +++ b/platform/android/DEVELOPING.md @@ -28,6 +28,7 @@ Clone the git repository and pull in submodules: ```bash git clone git@github.com:maplibre/maplibre-native.git +cd maplibre-native git submodule update --init --recursive cd platform/android ``` diff --git a/platform/node/DEVELOPING.md b/platform/node/DEVELOPING.md index 0bb201f8039..66c9de67cc5 100644 --- a/platform/node/DEVELOPING.md +++ b/platform/node/DEVELOPING.md @@ -64,15 +64,6 @@ Finally, build: cmake --build build -j $(nproc 2>/dev/null || sysctl -n hw.ncpu 2>/dev/null) ``` - -If you are rebuilding after time has passed. - -Then do: - -```bash -make node -``` - ## Testing To test the Node.js bindings: @@ -81,7 +72,6 @@ To test the Node.js bindings: npm test ``` - ## Merging your pull request To clean up your pull request and prepare it for merging, update your local `main` branch, then run `git rebase -i main` from your pull request branch to squash/fixup commits as needed. When your work is ready to be merged, you can run `git merge --ff-only YOUR_BRANCH` from `main` or click the green merge button in the GitHub UI, which will automatically squash your branch down into a single commit before merging it. diff --git a/platform/node/README.md b/platform/node/README.md index 327ef88b5e9..7063bc39600 100644 --- a/platform/node/README.md +++ b/platform/node/README.md @@ -25,7 +25,6 @@ Further platforms might work [with additional libraries installed](https://githu ``` npm test -npm run test-suite ``` ## Rendering a map tile