From c010ee9194608385ddf4f0fab54769698aa6ff38 Mon Sep 17 00:00:00 2001
From: Matthias Schiffer <mschiffer@universe-factory.net>
Date: Mon, 21 Aug 2023 21:50:32 +0200
Subject: [PATCH] Prepare for crates.io release

---
 Cargo.toml                 | 2 ++
 README.md                  | 2 +-
 crates/nbt/Cargo.toml      | 4 ++--
 crates/nbt/src/lib.rs      | 3 +--
 crates/resource/Cargo.toml | 4 ++--
 crates/resource/src/lib.rs | 4 +++-
 crates/types/Cargo.toml    | 4 ++--
 crates/types/src/lib.rs    | 3 +--
 src/core/mod.rs            | 4 ++--
 src/main.rs                | 3 +--
 10 files changed, 17 insertions(+), 16 deletions(-)

diff --git a/Cargo.toml b/Cargo.toml
index a536520..8bd65bd 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -9,8 +9,10 @@ repository = "https://github.com/NeoRaider/MinedMap"
 [package]
 name = "minedmap"
 version = "0.1.0"
+description = "Generate browsable maps from Minecraft save data"
 edition.workspace = true
 license.workspace = true
+readme.workspace = true
 repository.workspace = true
 default-run = "minedmap"
 
diff --git a/README.md b/README.md
index 372d31d..3b133fe 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@
 * Typically uses less than 100MB of RAM in single-threaded operation (may be higher when `-j` is passed)
 * Cross-platform: runs on Linux, Windows, and likely other systems like MacOS as well
 
-![Screenshot](docs/images/MinedMap.png)
+![Screenshot](https://raw.githubusercontent.com/NeoRaider/MinedMap/main/docs/images/MinedMap.png)
 
 ## How to use
 
diff --git a/crates/nbt/Cargo.toml b/crates/nbt/Cargo.toml
index e402a17..70802ec 100644
--- a/crates/nbt/Cargo.toml
+++ b/crates/nbt/Cargo.toml
@@ -1,12 +1,12 @@
 [package]
 name = "minedmap-nbt"
 version = "0.1.0"
+description = "MinedMap's handling of Minecraft NBT data and region files"
 edition.workspace = true
 license.workspace = true
+readme.workspace = true
 repository.workspace = true
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 anyhow = "1.0.75"
 bytemuck = "1.13.1"
diff --git a/crates/nbt/src/lib.rs b/crates/nbt/src/lib.rs
index 0b817b1..98e6d1b 100644
--- a/crates/nbt/src/lib.rs
+++ b/crates/nbt/src/lib.rs
@@ -1,5 +1,4 @@
-//! MinedMap's of Minecraft NBT data and region files
-
+#![doc = env!("CARGO_PKG_DESCRIPTION")]
 #![warn(missing_docs)]
 #![warn(clippy::missing_docs_in_private_items)]
 
diff --git a/crates/resource/Cargo.toml b/crates/resource/Cargo.toml
index 3321d28..78917da 100644
--- a/crates/resource/Cargo.toml
+++ b/crates/resource/Cargo.toml
@@ -1,12 +1,12 @@
 [package]
 name = "minedmap-resource"
 version = "0.1.0"
+description = "Data describing Minecraft biomes and block types"
 edition.workspace = true
 license.workspace = true
+readme.workspace = true
 repository.workspace = true
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 enumflags2 = { version = "0.7.7", features = ["serde"] }
 glam = "0.24.1"
diff --git a/crates/resource/src/lib.rs b/crates/resource/src/lib.rs
index a0854c5..5423bd7 100644
--- a/crates/resource/src/lib.rs
+++ b/crates/resource/src/lib.rs
@@ -1,4 +1,6 @@
-//! Data describing Minecraft biomes and block types
+#![doc = env!("CARGO_PKG_DESCRIPTION")]
+#![warn(missing_docs)]
+#![warn(clippy::missing_docs_in_private_items)]
 
 mod biomes;
 mod block_color;
diff --git a/crates/types/Cargo.toml b/crates/types/Cargo.toml
index 4830080..4097eea 100644
--- a/crates/types/Cargo.toml
+++ b/crates/types/Cargo.toml
@@ -1,12 +1,12 @@
 [package]
 name = "minedmap-types"
 version = "0.1.0"
+description = "Common types used by several MinedMap crates"
 edition.workspace = true
 license.workspace = true
+readme.workspace = true
 repository.workspace = true
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 itertools = "0.11.0"
 serde = { version = "1.0.183", features = ["derive"] }
diff --git a/crates/types/src/lib.rs b/crates/types/src/lib.rs
index 2e4ea61..e219a97 100644
--- a/crates/types/src/lib.rs
+++ b/crates/types/src/lib.rs
@@ -1,5 +1,4 @@
-//! Common types used by MinedMap
-
+#![doc = env!("CARGO_PKG_DESCRIPTION")]
 #![warn(missing_docs)]
 #![warn(clippy::missing_docs_in_private_items)]
 
diff --git a/src/core/mod.rs b/src/core/mod.rs
index 9c000e9..9c775c7 100644
--- a/src/core/mod.rs
+++ b/src/core/mod.rs
@@ -18,9 +18,9 @@ use region_processor::RegionProcessor;
 use tile_mipmapper::TileMipmapper;
 use tile_renderer::TileRenderer;
 
-/// Generate map tiles from Minecraft save data
+/// Command line arguments for minedmap CLI
 #[derive(Debug, Parser)]
-#[command(version)]
+#[command(version, about)]
 pub struct Args {
 	/// Number of parallel threads to use for processing
 	///
diff --git a/src/main.rs b/src/main.rs
index 4409dff..31f2889 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -1,5 +1,4 @@
-//! The minedmap generator renders map tile images from Minecraft save data
-
+#![doc = env!("CARGO_PKG_DESCRIPTION")]
 #![warn(missing_docs)]
 #![warn(clippy::missing_docs_in_private_items)]