From 1e8ac49b86596233c2e1b8d56a088b8cf68286b4 Mon Sep 17 00:00:00 2001 From: Daniel Schadt Date: Sat, 29 Nov 2025 17:20:13 +0100 Subject: slight readme adjustments --- Cargo.toml | 5 +++++ README.adoc | 16 +++++++++++++--- hittekaart/Cargo.toml | 3 +++ 3 files changed, 21 insertions(+), 3 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index f5f64c7..0dd9274 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,3 +3,8 @@ resolver = "3" members = [ "hittekaart", "hittekaart-cli", "hittekaart-py", ] + +[workspace.package] +readme = "README.adoc" +license = "GPL" +repository = "https://gitlab.com/dunj3/hittekaart" diff --git a/README.adoc b/README.adoc index 65256fd..bb779b5 100644 --- a/README.adoc +++ b/README.adoc @@ -260,7 +260,18 @@ With the tile server running, you can then open a HTML file like the following: ---- -== PYTHON INTERFACE +== HITTE AS A LIBRARY + +If you want to use `hittekaart` as part of another application, you can use one +of the following methods: + +=== RUST CRATE + +The `hittekaart` binary is powered by the `hittekaart` crate, which you can +find at https://crates.io/crates/hittekaart, and its documentation at +https://docs.rs/hittekaart. + +=== PYTHON LIBRARY This program comes with a Python interface, which allows easy use from Python scripts. The `hittekaart_py` subfolder in the repository is an installable @@ -292,8 +303,7 @@ https://gitlab.com/dunj3/hittekaart/-/issues or via email (see below). == AUTHOR -Daniel Schadt - contact me electronically with this project's name at -kingdread.de +Daniel Schadt - hittekaart at kingdread.de == COPYRIGHT diff --git a/hittekaart/Cargo.toml b/hittekaart/Cargo.toml index 651aec4..ee17c3a 100644 --- a/hittekaart/Cargo.toml +++ b/hittekaart/Cargo.toml @@ -3,6 +3,9 @@ name = "hittekaart" version = "0.1.0" edition = "2021" description = "Generates OSM heatmap tiles from GPX tracks" +readme.workspace = true +license.workspace = true +repository.workspace = true # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html -- cgit v1.2.3