archive-gh-me/maplibre-rs
1
0
Fork 0
mirror of https://github.com/maplibre/maplibre-rs.git synced 2025-12-08 19:05:57 +00:00
Code Issues Projects Releases Wiki Activity

docs: update README.md

Browse Source 
- Correct article agreement
- Fix broken rendering of logo HTML
- Correct spelling of macOS
- Fix the broken link to documentation
- Add punctuation to increase readability
- Trim trailing whitespace

Signed-off-by: Vladislav Doster <mvdoster@gmail.com>
This commit is contained in:
vladislav doster 2022-04-19 16:54:55 -05:00 committed by Vladislav Doster
parent f479d01bf6
commit 9b13f3a5d3
1 changed files with 17 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -1,9 +1,9 @@
<h1 align="center">mapr</h1>
<p align="center">
<img width="200px" alt="Logo" src="https://">
<img width="200px" src="https://static-assets.mapbox.com/www/logos/mapbox-logo-black.png" alt="Mapbox Logo">
</p>
<div align="center">
<img width="300px" src="docs/src/figures/mapr-ios.png" alt="preview">
<img width="300px" src="docs/src/figures/mapr-ios.png" alt="Preview">
</div>
<div align="center">
<strong>Native Maps for Web, Mobile and Linux</strong>
@ -13,13 +13,13 @@
</div>
<div align="center">
<img src="https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square"
<img src="https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square"
alt="Stability" />
<a href="https://github.com/maxammann/mapr/actions/workflows/rust.yml">
<a href="https://github.com/maxammann/mapr/actions/workflows/rust.yml">
<img src="https://github.com/maxammann/mapr/actions/workflows/rust.yml/badge.svg"
alt="Build status" />
alt="Build status" />
</a>
<a href="https://matrix.to/#/#mapr:matrix.org">
<a href="https://matrix.to/#/#mapr:matrix.org">
<img src="https://img.shields.io/static/v1?label=Space&message=%23mapr&color=blue&logo=matrix"
alt="Build status" />
</a>
@ -48,21 +48,21 @@
This project is in a proof-of-concept state. The proof of concept is done except for text rendering.
The Rust ecosystem is suited very well for this project.
In the future this project could be adopted and supported by [Maplibre](https://github.com/maplibre) to implement a
In the future, this project could be adopted and supported by [Maplibre](https://github.com/maplibre) to implement a
next-gen mapping solution.
## Description
mapr is a portable and performant vector maps renderer. We aim to support the web, mobile and desktop applications. This
mapr is a portable and performant vector maps renderer. We aim to support web, mobile and desktop applications. This
is achieved by the novel [WebGPU](https://www.w3.org/TR/webgpu/) specification. Plenty of native implementations are
already implementing this specification. On the web it is implemented by Firefox, Chrome and Safari. There are also
standalone implementations which directly use Vulkan, OpenGL or Metal as a backend. Those backends allow mapr to run on
already implementing this specification. On the web, it is implemented by Firefox, Chrome and Safari. There are also
standalone implementations that directly use Vulkan, OpenGL or Metal as a backend. Those backends allow mapr to run on
mobile and desktop applications.
Rust is used as a Lingua-franka on all platforms. This is made possible by WebAssembly which allows us to use Rust for
Rust is used as a Lingua-franka on all platforms. This is made possible by WebAssembly, which allows us to use Rust for
web development.
The goal of mapr is to render maps in order to visualize data. Right now the goal of mapr is not to replace existing
The goal of mapr is to render maps to visualize data. Right now the goal of mapr is not to replace existing
vector map renderers like Google Maps, Apple Maps or MapLibre. The current implementation serves as a proof-of-concept
of the used technology stack. It is unclear whether the high-performance requirements of rendering maps using vector
graphics are achievable using the current stack.
@ -75,7 +75,7 @@ https://user-images.githubusercontent.com/905221/163552617-5db04c66-23e3-4915-87
## Current Features
* Runs on Linux, Android, iOS, MacOS, Firefox and Chrome
* Runs on Linux, Android, iOS, macOS, Firefox and Chrome
* Render a vector tile dataset
* Simple navigation powered by winit
* Multithreaded on all platforms
@ -108,10 +108,10 @@ https://user-images.githubusercontent.com/905221/163552617-5db04c66-23e3-4915-87
│ ├── mbtiles # Library for extracting .mbtiles files
│ ├── style_spec # Library for interpreting MapLibre style specifications
│ └── wgsl_validate # Library for validating WGSL shaders
├── apple # Platform specific files for Apple (iOS and MacOS)
├── apple # Platform specific files for Apple (iOS and macOS)
├── web # Platform specific files for Web (WebGL and WebGPU)
├── benches # Benchmarks for specific parts of the library
├── examples # Examples which can be run
├── examples # Examples that can be run
└── test-data # Geo data which can be used for tests (Usually as .mbtiles)
```
@ -129,7 +129,7 @@ and then build it for running on a desktop:
cargo build
```
After that you can run it on your desktop:
After that, you can run it on your desktop:
```bash
cargo run --example desktop --
@ -160,5 +160,4 @@ dependency.
cargo doc --open
```
You can also view the up-to-date documentation [here](https://).
You can also view the up-to-date documentation [here](https://maxammann.org/mapr/docs/).