mirror of
https://github.com/nmandery/h3ron.git
synced 2025-12-08 19:45:56 +00:00
creating readme and license. bumping version to 0.4
This commit is contained in:
parent
eb65062766
commit
0ddab2ac25
23
LICENSE-MIT
Normal file
23
LICENSE-MIT
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
Permission is hereby granted, free of charge, to any
|
||||||
|
person obtaining a copy of this software and associated
|
||||||
|
documentation files (the "Software"), to deal in the
|
||||||
|
Software without restriction, including without
|
||||||
|
limitation the rights to use, copy, modify, merge,
|
||||||
|
publish, distribute, sublicense, and/or sell copies of
|
||||||
|
the Software, and to permit persons to whom the Software
|
||||||
|
is furnished to do so, subject to the following
|
||||||
|
conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice
|
||||||
|
shall be included in all copies or substantial portions
|
||||||
|
of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
|
||||||
|
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
|
||||||
|
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
|
||||||
|
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||||
|
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||||
|
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
|
||||||
|
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||||
|
DEALINGS IN THE SOFTWARE.
|
||||||
19
README.md
Normal file
19
README.md
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
# h3ron
|
||||||
|
|
||||||
|
[h3](https://h3geo.org) library for [rust](https://rustlang.org)
|
||||||
|
|
||||||
|
This repository consists of multiple crates:
|
||||||
|
|
||||||
|
* [h3ron-h3-sys](./h3ron-h3-sys): bindgen-generated bindings for statically linked libh3.
|
||||||
|
* [h3ron](./h3ron): high level rust API including collections for selected parts of H3.
|
||||||
|
* [h3ron-ndarray](./h3ron-ndarray): Integration with the [ndarray](https://github.com/rust-ndarray/ndarray) crate to generate H3 data from raster data (using [gdal](https://github.com/georust/gdal), ...)
|
||||||
|
|
||||||
|
## Why this name?
|
||||||
|
|
||||||
|
Well, coming up with a good name for a project while avoiding naming conflicts is hard. On the other hand are animal-based names always pretty easy to remember.
|
||||||
|
|
||||||
|
How to pronounce it? I got no idea - probably like the [heron bird family](https://en.wikipedia.org/wiki/Heron).
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
[MIT](./LICENSE-MIT)
|
||||||
@ -1,11 +1,12 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "h3ron-h3-sys"
|
name = "h3ron-h3-sys"
|
||||||
version = "3.7.1" # version matches the bundled libh3
|
version = "3.7.1" # version matches the bundled libh3
|
||||||
description = "bindings to libh3, bindgen generated, libh3 is bundled"
|
description = "bindgen-generated bindings for statically linked libh3"
|
||||||
authors = ["Nico Mandery <nico@nmandery.net>"]
|
authors = ["Nico Mandery <nico@nmandery.net>"]
|
||||||
build = "build.rs"
|
build = "build.rs"
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
edition = "2018"
|
edition = "2018"
|
||||||
|
keywords = ["geo", "spatial", "h3"]
|
||||||
|
|
||||||
[lib]
|
[lib]
|
||||||
|
|
||||||
|
|||||||
@ -1,8 +1,11 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "h3ron-ndarray"
|
name = "h3ron-ndarray"
|
||||||
version = "0.1.0"
|
version = "0.4.0"
|
||||||
authors = ["Nico Mandery <nico@nmandery.net>"]
|
authors = ["Nico Mandery <nico@nmandery.net>"]
|
||||||
|
description = "Integration with the ndarray crate to generate H3 data from raster data (using gdal, ...)"
|
||||||
edition = "2018"
|
edition = "2018"
|
||||||
|
license = "MIT"
|
||||||
|
keywords = ["geo", "spatial", "h3", "ndarray"]
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
geo-types = "^0.6"
|
geo-types = "^0.6"
|
||||||
@ -11,7 +14,7 @@ log = "^0.4"
|
|||||||
|
|
||||||
[dependencies.ndarray]
|
[dependencies.ndarray]
|
||||||
version = "^0.14"
|
version = "^0.14"
|
||||||
features = [ "rayon" ]
|
features = ["rayon"]
|
||||||
|
|
||||||
[dependencies.h3ron]
|
[dependencies.h3ron]
|
||||||
path = "../h3ron"
|
path = "../h3ron"
|
||||||
@ -24,7 +27,7 @@ criterion = "^0.3"
|
|||||||
|
|
||||||
[dev-dependencies.gdal]
|
[dev-dependencies.gdal]
|
||||||
version = "^0.7"
|
version = "^0.7"
|
||||||
features = [ "array" ]
|
features = ["array"]
|
||||||
|
|
||||||
|
|
||||||
[[bench]]
|
[[bench]]
|
||||||
|
|||||||
@ -1,8 +1,11 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "h3ron"
|
name = "h3ron"
|
||||||
version = "0.3.3"
|
description = "high level rust API including collections for selected parts of H3"
|
||||||
|
version = "0.4.0"
|
||||||
authors = ["Nico Mandery <nico@nmandery.net>"]
|
authors = ["Nico Mandery <nico@nmandery.net>"]
|
||||||
edition = "2018"
|
edition = "2018"
|
||||||
|
license = "MIT"
|
||||||
|
keywords = ["geo", "spatial", "h3"]
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
h3ron-h3-sys = { path = "../h3ron-h3-sys" }
|
h3ron-h3-sys = { path = "../h3ron-h3-sys" }
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user