replace lib docs with readme

This commit is contained in:
brevalferrari 2025-06-19 18:04:54 +02:00
parent c27d87f7c0
commit ba653ce9e8
Signed by: breval
GPG key ID: 913954DA013FAD4F
4 changed files with 13 additions and 12 deletions

2
Cargo.lock generated
View file

@ -87,7 +87,7 @@ checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6"
[[package]]
name = "bliplab"
version = "0.0.1"
version = "0.0.2"
dependencies = [
"anyhow",
"bliplib",

View file

@ -1,6 +1,6 @@
[package]
name = "bliplab"
version = "0.0.1"
version = "0.0.2"
edition = "2024"
authors = ["Breval Ferrari <breval.ferrari@fish.golf>"]
description = "Tool to combine several BLIP channels in a song"

10
README.md Normal file
View file

@ -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.

View file

@ -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};