battery_pack/lib.rs
1//! battery-pack: Framework for building battery packs.
2//!
3//! Battery packs are curated collections of crates that work well together,
4//! re-exported through a single facade for easy consumption.
5//!
6//! # For Battery Pack Authors
7//!
8//! Use `cargo battery new my-pack` to create a new battery pack, or add the
9//! following to an existing crate:
10//!
11//! **Cargo.toml:**
12//! ```toml
13//! [package.metadata.battery]
14//! schema_version = 1
15//!
16//! [build-dependencies]
17//! battery-pack = "0.1"
18//! ```
19//!
20//! **build.rs:**
21//! ```rust,ignore
22//! fn main() -> Result<(), battery_pack::build::Error> {
23//! battery_pack::build::generate_facade()
24//! }
25//! ```
26//!
27//! **lib.rs:**
28//! ```rust,ignore
29//! include!(concat!(env!("OUT_DIR"), "/facade.rs"));
30//! ```
31
32pub use bphelper_build as build;