mirror of
https://github.com/marceloprates/prettymaps.git
synced 2025-09-03 03:13:47 +02:00
Enhance documentation with detailed usage examples and feature descriptions for Prettymaps.
This commit is contained in:
@@ -1,3 +1,24 @@
|
||||
# Prettymaps Documentation
|
||||
|
||||
Welcome to the Prettymaps documentation site.
|
||||
Welcome to the Prettymaps documentation site.
|
||||
|
||||
Prettymaps is a minimal Python library to draw beautiful maps from OpenStreetMap data.
|
||||
It allows you to easily generate artistic, customizable maps for any location in the world.
|
||||
|
||||
## Features
|
||||
|
||||
- Fetches and visualizes OpenStreetMap data with minimal code
|
||||
- Highly customizable layers and styles
|
||||
- Supports elevation, hillshading, and keypoints
|
||||
- Preset system for reusable map styles
|
||||
- Export to PNG, SVG, and plotter-friendly formats
|
||||
|
||||
## Quick Example
|
||||
|
||||
```python
|
||||
import prettymaps
|
||||
|
||||
prettymaps.plot("Porto Alegre, Brazil")
|
||||
```
|
||||
|
||||
Explore the [Usage](usage.md) and [API Reference](api.md) for more details.
|
Reference in New Issue
Block a user