Skip to content

Create readme.md #137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Sudz wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Create readme.md #137

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Prettymaps (map2025)

> Draw beautiful maps from OpenStreetMap data, using Python, matplotlib, and osmnx
> **Forked from [marceloprates/prettymaps](https://github.com/marceloprates/prettymaps)**

---

## 🎨 What is Prettymaps?

Prettymaps is a small Python library that lets anyone quickly generate highly customisable, beautiful maps from OpenStreetMap data.
It works on your laptop, server, or even Google Colab!

---

## 🗺️ Features

- **Draw any place.** Specify a city name, address, or coordinates.
- **Choose your style.** Customise layers, colours, and map features (buildings, roads, parks, water, more).
- **Output as PNG or SVG.** Save static images or generate vector files for printing.
- **Works with plotter mode.** Create pen-plotter-friendly SVGs (with [vsketch](https://github.com/abey79/vsketch)).
- **Use in Jupyter/Colab.** Interactive notebook workflow supported.

---

## 🚀 Quickstart

Install with pip (Python 3.8+ required):