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 12cabe845dc87f2e4876ed23ee68163487ab84c0..0c9ada05e665245fb4cb95ea65c6e0ac67956287 100644 (file)
--- 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 d6d624675b4df28e54eab83d49e4ca51ad3952c1..89ba2a0278b5ee97764d009fd1740fac3f67746a 100644 (file)
--- 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 50c0b4f3a929a4d64abbaff5e51a59a8955c7580..0e53f2e708a91a1e311e9368d1f5d3a7a0721f5a 100644 (file)
--- 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;