From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Sat, 2 Apr 2022 11:54:37 +0000 (+0100)
Subject: Bespoke doc comments for otter, otter-cli and otter-daemon
X-Git-Tag: otter-1.0.0~10
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=d6a6baa24c0855801eaa3915976d678489ea8741;p=otter.git

Bespoke doc comments for otter, otter-cli and otter-daemon

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
---

diff --git a/cli/otter.rs b/cli/otter.rs
index 12cabe84..0c9ada05 100644
--- a/cli/otter.rs
+++ b/cli/otter.rs
@@ -2,6 +2,14 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 // There is NO WARRANTY.
 
+//! Otter game system - command line client
+//!
+//! For use with an Otter server.  You can `cargo install otter-cli`.
+//!
+//! See the
+//! [Otter web pages](https://www.chiark.greenend.org.uk/~ianmdlvl/otter/docs/README.html)
+//! for more information about Otter.
+
 #![allow(unused_imports)]
 
 pub type MgmtChannel = ClientMgmtChannel;
diff --git a/daemon/main.rs b/daemon/main.rs
index d6d62467..89ba2a02 100644
--- a/daemon/main.rs
+++ b/daemon/main.rs
@@ -2,6 +2,13 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 // There is NO WARRANTY.
 
+//! Otter game system - main server daemon
+//!
+//! <https://www.chiark.greenend.org.uk/~ianmdlvl/otter/docs/README.html>
+//!
+//! This program requires many additional runtime resources, which you are
+//! expected to build, along with the daemon, using the Otter `Makefile`.
+
 use otter::imports::*;
 
 pub mod imports;
diff --git a/src/lib.rs b/src/lib.rs
index 50c0b4f3..0e53f2e7 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -2,6 +2,22 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 // There is NO WARRANTY.
 
+//! Otter game system; common infrastructure Rust crate.
+//!
+//! Otter, the Online Table Top Environment Renderer,
+//! is an online game system.
+//!
+//! <https://www.chiark.greenend.org.uk/~ianmdlvl/otter/docs/README.html>
+//!
+//! This crate is intended for use only by other parts of Otter.
+//!
+//! The command line client for joining and managing games is
+//! available via
+//! [`cargo install otter-cli`](https://lib.rs/crates/otter-cli)
+//!
+//! To run an Otter server, you will need to read the
+//! [build instructions](https://www.chiark.greenend.org.uk/~ianmdlvl/otter/docs/build.html).
+
 pub mod imports;
 pub mod prelude;