Skip to content

Commit

Permalink
updated install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
felix-ht committed Dec 2, 2024
1 parent cc3a53c commit eb1f1c4
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 8 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,24 +19,21 @@ Input data must be in the `EPSG:4326` - WGS84 projection.


## Installation
To install the Mapsy library, clone the repository and install the required dependencies:
You can simply install the library using pip:

```bash
git clone <repository-url>
cd mapsy
poetry install
# or
pip install .
pip install mapsy
```

This library uses Cairo. You have to install cairo with your package manger of choice.
IMPORTANT: This library uses Cairo. You will have to install cairo with your package manager of choice.

on mac

```bash
brew install cairo
```


## Usage

The Mapsy library is designed to be simple to use. The following sections provide examples of how to create a map with different layers. Note that in almost all cases you would have to add an attribution layer to the map. For example, if you use OpenStreetMap tiles, you would have to add the OpenStreetMap attribution to the map. This is not done automatically!
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "mapsy"
version = "0.2.0"
version = "0.2.1"
description = "Mapsy is a Python library designed easily render static maps in python."
authors = ["Felix Horvat <[email protected]>"]
readme = "README.md"
Expand Down

0 comments on commit eb1f1c4

Please sign in to comment.