From ab7ce67ad7d2c18c508bb9f4009ce20039607fa7 Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Wed, 14 Dec 2022 22:15:05 +0000 Subject: [PATCH] Add lib.rs rustdoc stub documentation Signed-off-by: Ian Jackson --- src/lib.rs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index 16ef74f..06a3c08 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -2,6 +2,14 @@ // SPDX-License-Identifier: GPL-3.0-or-later WITH LicenseRef-Hippotat-OpenSSL-Exception // There is NO WARRANTY. +//! Library crate for Hippotat +//! +//! These libraries are for use within the Hippotat cargo package. +//! They do not have a stable API. +//! +//! Please refer to the +//! [project documentation](https://www.chiark.greenend.org.uk/~ianmdlvl/hippotat/current/docs/) + pub mod prelude; pub mod config; -- 2.30.2