From ba653ce9e8f2efa6657a59a137d0fecaec4f14de Mon Sep 17 00:00:00 2001 From: brevalferrari Date: Thu, 19 Jun 2025 18:04:54 +0200 Subject: [PATCH] replace lib docs with readme --- Cargo.lock | 2 +- Cargo.toml | 2 +- README.md | 10 ++++++++++ src/lib.rs | 11 +---------- 4 files changed, 13 insertions(+), 12 deletions(-) create mode 100644 README.md diff --git a/Cargo.lock b/Cargo.lock index f03d9b4..db4580a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -87,7 +87,7 @@ checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6" [[package]] name = "bliplab" -version = "0.0.1" +version = "0.0.2" dependencies = [ "anyhow", "bliplib", diff --git a/Cargo.toml b/Cargo.toml index 2bf022b..24ab297 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "bliplab" -version = "0.0.1" +version = "0.0.2" edition = "2024" authors = ["Breval Ferrari "] description = "Tool to combine several BLIP channels in a song" diff --git a/README.md b/README.md new file mode 100644 index 0000000..d2daab9 --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# BLIP lab +[BLIP](https://crates.io/crates/bliplib) works for just one instrument. + +With This tool, you can turn command-line options into a single file using serialization (with serde) to have multiple channels at once. + +The CLI can be installed by enabling the "bin" feature : +```bash +cargo install bliplab --features bin +``` +A variety of data formats other than JSON will be available by enabling other features. \ No newline at end of file diff --git a/src/lib.rs b/src/lib.rs index 1f677aa..b5b0922 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,13 +1,4 @@ -//! BLIPlab is a tool to help you write a song for more than one instrument. -//! -//! [BLIP](https://crates.io/crates/bliplib) works for just one instrument. -//! This tool can turn command-line options into a single file using serialization (with serde). -//! -//! The CLI can be installed by enabling the "bin" feature : -//! ```bash -//! cargo install bliplab --features bin -//! ``` -//! A variety of data formats other than JSON will be available by enabling other features. +#![doc = "../README.md"] use std::{borrow::Cow, collections::HashMap, path::PathBuf};