improving readme

tum-gis · Aug 5, 2024 · 79dce7d · 79dce7d
1 parent 501b416
commit 79dce7d
Show file tree

Hide file tree

Showing 13 changed files with 35 additions and 30 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -8,6 +8,13 @@ on:
   pull_request: {}
 
 
+env:
+  CARGO_INCREMENTAL: 0
+  CARGO_NET_RETRY: 10
+  RUSTUP_MAX_RETRIES: 10
+  RUST_BACKTRACE: short
+
+
 jobs:
 
   build:

diff --git a/Cargo.toml b/Cargo.toml
@@ -6,22 +6,22 @@ members = [
 resolver = "2"
 
 [workspace.package]
-version = "0.0.1-alpha.3"
+version = "0.0.1-alpha.4"
 authors = ["Benedikt Schwab <benedikt.schwab@gmail.com>"]
 edition = "2021"
 license = "MIT OR Apache-2.0"
 repository = "https://github.com/envis-space/ecoord"
 
 [workspace.dependencies]
-clap = "4.5.8"
-thiserror = "1.0.61"
-serde = "1.0.203"
-serde_json = "1.0.120"
-zstd = "0.13.1"
+clap = "4.5.13"
+thiserror = "1.0.63"
+serde = "1.0.204"
+serde_json = "1.0.122"
+zstd = "0.13.2"
 nalgebra = "0.33.0"
 chrono = "0.4.38"
 itertools = "0.13.0"
-indextree = "4.6.1"
+indextree = "4.7.0"
 tracing = "0.1.40"
 tracing-subscriber = "0.3.18"
 approx = "0.5.1"

diff --git a/README.md b/README.md
@@ -2,8 +2,7 @@
 
 A Rust library for transforming between 3D coordinate frames.
 
-> [!WARNING]  
-> The library is at an early stage of development.
+The library is at an early stage of development.
 
 ## Contributing
 

diff --git a/crates/ecoord-cli/Cargo.toml b/crates/ecoord-cli/Cargo.toml
@@ -5,11 +5,11 @@ authors.workspace = true
 edition.workspace = true
 license.workspace = true
 repository.workspace = true
-description = "CLI tool for transforms between 3D coordinate frames."
+description = "CLI tool for transforming between 3D coordinate frames."
 
 
 [dependencies]
-ecoord = { version = "0.0.1-alpha.3", path = "../ecoord" }
+ecoord = { version = "0.0.1-alpha.4", path = "../ecoord" }
 
 clap = { workspace = true, features = ["derive"] }
 tracing = { workspace = true }

diff --git a/crates/ecoord-cli/README.md b/crates/ecoord-cli/README.md
@@ -1,6 +1,6 @@
 # ecoord-cli
 
-CLI tool for transforms between 3D coordinate frames.
+CLI tool for transforming between 3D coordinate frames.
 
 ## Contributing
 

diff --git a/crates/ecoord-core/Cargo.toml b/crates/ecoord-core/Cargo.toml
@@ -5,7 +5,7 @@ authors.workspace = true
 edition.workspace = true
 license.workspace = true
 repository.workspace = true
-description = "Core primitives and operations for transforms between 3D coordinate frames."
+description = "Core primitives and operations for transforming between 3D coordinate frames."
 
 
 [dependencies]

diff --git a/crates/ecoord-core/README.md b/crates/ecoord-core/README.md
@@ -1,6 +1,6 @@
-# ecoord-cli
+# ecoord-core
 
-Core primitives and operations for transforms between 3D coordinate frames.
+Core primitives and operations for transforming between 3D coordinate frames.
 
 ## Contributing
 

diff --git a/crates/ecoord-io/Cargo.toml b/crates/ecoord-io/Cargo.toml
@@ -5,11 +5,11 @@ authors.workspace = true
 edition.workspace = true
 license.workspace = true
 repository.workspace = true
-description = "IO operations for transforms between 3D coordinate frames."
+description = "IO operations for transforming between 3D coordinate frames."
 
 
 [dependencies]
-ecoord-core = { version = "0.0.1-alpha.3", path = "../ecoord-core" }
+ecoord-core = { version = "0.0.1-alpha.4", path = "../ecoord-core" }
 
 thiserror = { workspace = true }
 serde = { workspace = true, features = [ "derive" ] }

diff --git a/crates/ecoord-io/README.md b/crates/ecoord-io/README.md
@@ -1,6 +1,6 @@
-# ecoord-cli
+# ecoord-io
 
-IO operations for transforms between 3D coordinate frames.
+IO operations for transforming between 3D coordinate frames.
 
 ## Contributing
 

diff --git a/crates/ecoord-transform/Cargo.toml b/crates/ecoord-transform/Cargo.toml
@@ -5,10 +5,10 @@ authors.workspace = true
 edition.workspace = true
 license.workspace = true
 repository.workspace = true
-description = "Supplementary operations for transforms between 3D coordinate frames."
+description = "Supplementary operations for transforming between 3D coordinate frames."
 
 [dependencies]
-ecoord-core = { version = "0.0.1-alpha.3", path = "../ecoord-core" }
+ecoord-core = { version = "0.0.1-alpha.4", path = "../ecoord-core" }
 
 thiserror = { workspace = true }
 itertools = { workspace = true }

diff --git a/crates/ecoord-transform/README.md b/crates/ecoord-transform/README.md
@@ -1,6 +1,6 @@
-# ecoord-cli
+# ecoord-transform
 
-Supplementary operations for transforms between 3D coordinate frames.
+Supplementary operations for transforming between 3D coordinate frames.
 
 ## Contributing
 

diff --git a/crates/ecoord/Cargo.toml b/crates/ecoord/Cargo.toml
@@ -5,11 +5,11 @@ authors.workspace = true
 edition.workspace = true
 license.workspace = true
 repository.workspace = true
-description = "Transforms between 3D coordinate frames."
+description = "Library for transforming between 3D coordinate frames."
 
 [features]
 
 [dependencies]
-ecoord-core = { version = "0.0.1-alpha.3", path = "../ecoord-core" }
-ecoord-transform = { version = "0.0.1-alpha.3", path = "../ecoord-transform" }
-ecoord-io = { version = "0.0.1-alpha.3", path = "../ecoord-io" }
+ecoord-core = { version = "0.0.1-alpha.4", path = "../ecoord-core" }
+ecoord-transform = { version = "0.0.1-alpha.4", path = "../ecoord-transform" }
+ecoord-io = { version = "0.0.1-alpha.4", path = "../ecoord-io" }
diff --git a/crates/ecoord/README.md b/crates/ecoord/README.md
@@ -1,9 +1,8 @@
 # ecoord
 
-Transforms between 3D coordinate frames.
+Library for transforming between 3D coordinate frames.
 
-> [!WARNING]  
-> The library is at an early stage of development.
+The library is at an early stage of development.
 
 ## Contributing