chore: prepare for publish and release

matteocarnelos · Feb 8, 2024 · 3a00e78 · 3a00e78
1 parent 47eb6a0
commit 3a00e78
Show file tree

Hide file tree

Showing 7 changed files with 55 additions and 8 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,24 @@
 [package]
 name = "microflow"
-version = "0.1.0"
+description = "A robust and efficient TinyML inference engine for embedded systems"
+authors = ["Matteo Carnelos <matteo.carnelos98@gmail.com>"]
+documentation = "https://docs.rs/microflow"
+repository = "https://github.com/matteocarnelos/microflow"
+categories = ["embedded", "no-std", "science"]
+keywords = ["tinyml"]
+license = "MIT OR Apache-2.0"
+version = "0.1.1"
 edition = "2021"
+include = [
+    "/src/**",
+    "/benches/**",
+    "/tests/**",
+    "/models/**",
+    "/Cargo.toml",
+    "/LICENSE-MIT",
+    "/LICENSE-APACHE",
+    "/README.md",
+]
 
 [dependencies]
 microflow-macros = { version = "0.1", path = "microflow-macros" }

diff --git a/README.md b/README.md
@@ -1,10 +1,12 @@
 # MicroFlow
-> A [Rust](https://www.rust-lang.org) TinyML Compiler for Neural Network Inference on Embedded Systems
+> A [Rust](https://www.rust-lang.org) TinyML compiler for neural network inference on embedded systems
 
+[![crates.io](https://img.shields.io/crates/v/microflow)](https://crates.io/crates/microflow)
+[![docs.rs](https://img.shields.io/docsrs/microflow)](https://docs.rs/microflow)
 [![github](https://img.shields.io/github/actions/workflow/status/matteocarnelos/microflow-rs/cargo.yml?branch=main)](https://github.com/matteocarnelos/microflow-rs/actions/workflows/cargo.yml)
 
 MicroFlow is a robust and efficient TinyML inference engine designed for deploying machine learning models on embedded systems.
-It was developed by Matteo Carnelos as part of his master's thesis project at the [University of Padova](https://www.unipd.it) in collaboration with [Grepit AB](https://www.grepit.se).
+It was developed by Matteo Carnelos as part of his master's thesis project at the [University of Padova](https://www.unipd.it/en/) in collaboration with [Grepit AB](https://github.com/GrepitAB).
 
 MicroFlow uses a compiler-based approach, resulting in the following engine structure:
 
@@ -112,4 +114,4 @@ Licensed under either of
 
 at your option.
 
-Copyright © 2023, [Matteo Carnelos](https://github.com/matteocarnelos)
+Copyright © 2024, [Matteo Carnelos](https://github.com/matteocarnelos)
diff --git a/microflow-macros/Cargo.toml b/microflow-macros/Cargo.toml
@@ -1,18 +1,33 @@
 [package]
 name = "microflow-macros"
-version = "0.1.0"
+description = "Macro crate of the MicroFlow inference engine, namely, the MicroFlow compiler"
+authors = ["Matteo Carnelos <matteo.carnelos98@gmail.com>"]
+documentation = "https://docs.rs/microflow-macros"
+repository = "https://github.com/matteocarnelos/microflow-rs"
+readme = "../README.md"
+categories = ["embedded", "no-std", "science"]
+keywords = ["tinyml"]
+license = "MIT OR Apache-2.0"
+version = "0.1.1"
 edition = "2021"
+include = [
+    "/src/**",
+    "flatbuffers/**",
+    "/Cargo.toml",
+    "/LICENSE-MIT",
+    "/LICENSE-APACHE",
+]
 
 [lib]
 proc-macro = true
 
 [dependencies]
-syn = "1.0"
+syn = { version = "2.0", features = ["full"] }
 quote = "1.0"
 proc-macro2 = "1.0"
 proc-macro-error = "1.0"
 flatbuffers = "23.1"
 nalgebra = "0.32"
 simba = "0.8"
 byterepr = "0.1"
-structmeta = "0.1"
+structmeta = "0.3"
diff --git a/microflow-macros/LICENSE-APACHE b/microflow-macros/LICENSE-APACHE
@@ -0,0 +1 @@
+../LICENSE-APACHE
diff --git a/microflow-macros/LICENSE-MIT b/microflow-macros/LICENSE-MIT
@@ -0,0 +1 @@
+../LICENSE-MIT
diff --git a/microflow-macros/src/lib.rs b/microflow-macros/src/lib.rs
@@ -1,3 +1,9 @@
+//! [![crates.io](https://img.shields.io/crates/v/microflow-macros)](https://crates.io/crates/microflow-macros)
+//! [![docs.rs](https://img.shields.io/docsrs/microflow-macros)](https://docs.rs/microflow-macros)
+//! [![github](https://img.shields.io/github/actions/workflow/status/matteocarnelos/microflow-rs/cargo.yml?branch=main)](https://github.com/matteocarnelos/microflow-rs/actions/workflows/cargo.yml)
+//!
+//! Macro crate of the [MicroFlow](https://github.com/matteocarnelos/microflow-rs) inference engine, namely, the MicroFlow compiler.
+
 extern crate proc_macro;
 
 use proc_macro::TokenStream;

diff --git a/src/lib.rs b/src/lib.rs
@@ -1,4 +1,9 @@
-#![doc = include_str!("../README.md")]
+//! [![crates.io](https://img.shields.io/crates/v/microflow)](https://crates.io/crates/microflow)
+//! [![docs.rs](https://img.shields.io/docsrs/microflow)](https://docs.rs/microflow)
+//! [![github](https://img.shields.io/github/actions/workflow/status/matteocarnelos/microflow-rs/cargo.yml?branch=main)](https://github.com/matteocarnelos/microflow-rs/actions/workflows/cargo.yml)
+//!
+//! A robust and efficient TinyML inference engine for embedded systems.
+
 #![no_std]
 
 pub use microflow_macros::*;