v0.1.1 (#159)

LuckyTurtleDev · Jul 14, 2023 · 32f4382 · 32f4382
1 parent 85cc345
commit 32f4382
Show file tree

Hide file tree

Showing 10 changed files with 80 additions and 53 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/README.md b/README.md
diff --git a/macro/Cargo.toml b/macro/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 workspace = ".."
 name = "mission2teegarden-b-macro"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 rust-version = "1.70"
 publish = false
@@ -15,6 +15,6 @@ proc-macro = true
 [dependencies]
 bincode = { version = "2.0.0-rc.3", features = ["derive"] }
 glob = "0.3.1"
-mission2teegarden-b-map = { version = "0.1.0", path = "../map" }
+mission2teegarden-b-map = { version = "0.2.0", path = "../map" }
 proc-macro2 = "1.0.56"
 quote = "1.0.26"
diff --git a/map/Cargo.toml b/map/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 workspace = ".."
 name = "mission2teegarden-b-map"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 rust-version = "1.70"
 description = "Private implementation detail of mission2teegarden-b"
@@ -14,7 +14,7 @@ anyhow = "1.0.71"
 basic-toml = "0.1.2"
 clap = { version = "4.2.5", features = ["derive"] }
 log = "0.4.17"
-mission2teegarden-b-models = { version = "0.1.0", path = "../models", features = ["serde"] }
+mission2teegarden-b-models = { version = "0.2.0", path = "../models", features = ["serde"] }
 num_enum = "0.6.1"
 ron = "0.8.0"
 serde = { version = "1.0.163", features = ["derive"] }

diff --git a/map/src/lib.rs b/map/src/lib.rs
@@ -91,6 +91,15 @@
 //! ```
 //! Executing one of the commands creates a file with the same basename as the original file and the extension `.m2tb_map` inside the current working directory.
 //! Since the map format is not stable yet and can not be editet after exporting, it is strongly recommanded to keep the original `.tmx` file
+//!
+//! ### Play Map
+//! To play a map start the game and navigate to
+//! `Play -> Import Level`.
+//!
+//! Alternatvie the command line interface can be used:
+//! ```bash
+//! mission2teegarden-b play [FILE]
+//! ```
 
 use anyhow::{bail, Context};
 use basic_toml as toml;

diff --git a/models/Cargo.toml b/models/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 workspace = ".."
 name = "mission2teegarden-b-models"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 rust-version = "1.70"
 description = "Private implementation detail of mission2teegarden-b"

diff --git a/pc/Cargo.toml b/pc/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 workspace = ".."
 name = "mission2teegarden-b"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 rust-version = "1.70"
 publish = false
@@ -16,9 +16,9 @@ anyhow = "1.0.71"
 bincode = { version = "2.0.0-rc.3", features = ["derive"] }
 clap = { version = "4.3.9", features = ["derive"] }
 log = "0.4.17"
-mission2teegarden-b-macro = { version = "0.1.0", path = "../macro" }
-mission2teegarden-b-map = { version = "0.1.0", path = "../map" }
-mission2teegarden-b-models = { version = "0.1.0", path = "../models" }
+mission2teegarden-b-macro = { version = "0.2.0", path = "../macro" }
+mission2teegarden-b-map = { version = "0.2.0", path = "../map" }
+mission2teegarden-b-models = { version = "0.2.0", path = "../models" }
 macroquad = { version = "0.3.25", default-features = false, features = ["log-rs"] }
 my-env-logger-style = "0.1.0"
 num_enum = "0.6.1"

diff --git a/pc/README.j2 b/pc/README.j2
@@ -7,6 +7,8 @@
 [![Source Code Repository](https://img.shields.io/badge/Code-On%20GitHub-blue?logo=GitHub)]({{ repository }})
 ![Rust Version: {{rust_version}}](https://img.shields.io/badge/rustc-{{ rust_version | urlencode }}-orange.svg)
 
+<img src="https://github.com/LuckyTurtleDev/mission2teegarden-b/assets/44570204/584254b2-55f9-4f3d-b590-fa06b86343ec" width=100%>
+
 {{ readme }}
 
 {%- if links != "" %}

diff --git a/pc/src/main.rs b/pc/src/main.rs
@@ -30,16 +30,25 @@
 //!
 //! Prebuild binaries can also be downloaded from the
 #![doc=concat!("[GitHub release](https://github.com/LuckyTurtleDev/mission2teegarden-b/releases/v",env!("CARGO_PKG_VERSION"),").")]
+//! On Unix system the binary must may be marked as executable by running `chmod u+x mission2teegarden-b` afer unpacking the zip archive.
+//! On Linux the following dependencies are needed.
+//! Regular these are already installed.
+//! * [`alsa-lib`](https://github.com/alsa-project/alsa-lib)
+//! * [`gtk3`](https://gitlab.gnome.org/GNOME/gtk)
+//! * [`libudev`](https://github.com/systemd/systemd)
 //!
 //! Mission to Teegarden b is only tested on Arch Linux and Ubuntu.
-//! MacOs and Windows versions complie sucessfull but are untested.
-//! Supressing standby on MacOs is temporary disable, see [#157](https://github.com/LuckyTurtleDev/mission2teegarden-b/issues/157).
+//! MacOS and Windows versions complie sucessfull but are untested.
+//! Supressing standby on MacOS is temporary disable, see [#157](https://github.com/LuckyTurtleDev/mission2teegarden-b/issues/157).
+//!
+//!
 //! ### Building from source:
 //! Alternative you can easily build Mission to Teegarden b  by yourself:
 //! * On Linux, install the following development dependencies.
 //! On some distros (like Alpine and Debian), separate development packages exist, regular suffixed with `-dev`.
 //! If this is the case, make sure that you have also installed the `*-dev` version.
 //!   * [`alsa-lib`](https://github.com/alsa-project/alsa-lib)
+//!   * [`gtk3`](https://gitlab.gnome.org/GNOME/gtk)
 //!   * [`libudev`](https://github.com/systemd/systemd)
 //! * [Install rust](https://www.rust-lang.org/tools/install)
 #![doc=concat!("* [Download](https://github.com/LuckyTurtleDev/mission2teegarden-b/archive/refs/tags/v",env!("CARGO_PKG_VERSION"),".zip)")]
@@ -54,14 +63,12 @@
 //! * Download and unpack Pybadge binary from
 #![doc=concat!("[GitHub release](https://github.com/LuckyTurtleDev/mission2teegarden-b/releases/v",env!("CARGO_PKG_VERSION"),").")]
 //! * Press the reset button of the pybdage twice, to enter the bootloader.
-//! * After this, execute `hf2 elf mission2teegarden-b-pybadge` (or the corresponding command of your flashing tool) to flash the binary to the pybadge.
+//! * After this, execute `hf2 elf mission2teegarden-b-pybadge.elf` (or the corresponding command of your flashing tool) to flash the binary to the pybadge.
 //! * Press the reset button again.
 //! ### Building from source:
 //! Alternative you can build m3 by yourself:
 //! * [Install rustup](https://www.rust-lang.org/tools/install)
-//! * Run `cargo install hf2-cli --locked` to build and install the [hf2-cli](https://crates.io/crates/hf2-cli) flasher.
-//! See the [rust book](https://doc.rust-lang.org/cargo/commands/cargo-install.html) for more information about cargo install.
-//! * Make sure that `~/.cargo/bin` is listed at the `PATH` environment variable, otherwise the executeable can not be found..
+//! * [Install hf2-cli](https://crates.io/crates/hf2-cli) flasher.
 //! * Install the rust `thumbv7em-none-eabihf` target (the architecture of the pybadge) by executing `rustup target install thumbv7em-none-eabihf`.
 //! * Optional: install nightly toolchain for better error messages at the pybadge. `rustup toolchain install nightly --target thumbv7em-none-eabihf`
 #![doc=concat!("* [Download](https://github.com/LuckyTurtleDev/mission2teegarden-b/archive/refs/tags/v",env!("CARGO_PKG_VERSION"),".zip)")]

diff --git a/pybadge/Cargo.toml b/pybadge/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 workspace = ".."
 name = "mission2teegarden-b-pybadge"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 rust-version = "1.70"
 publish = false
@@ -13,7 +13,7 @@ bincode = { version = "2.0.0-rc.3", default-features = false, features = ["deriv
 embedded-graphics = "0.7.1"
 embedded-sprites = "0.1.2"
 heapless = "0.7.16"
-mission2teegarden-b-models = { version = "0.1.0", path = "../models" }
+mission2teegarden-b-models = { version = "0.2.0", path = "../models" }
 pybadge-high = { version = "0.2.0", features = ["usb", "time", "bluescreen", "bluescreen-message-nightly", "neopixel"] }
 strum = { version = "0.25.0", default-features = false }