From e678e3bf9e5f095e9c70108f1268d3919ff987d2 Mon Sep 17 00:00:00 2001 From: Nathan Lilienthal Date: Sun, 22 Sep 2024 08:43:11 -0400 Subject: [PATCH] Start cleaning up docs --- src/lib.rs | 44 ++++++++++++++++---------------------------- 1 file changed, 16 insertions(+), 28 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 4f48164..421633b 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -19,34 +19,20 @@ //! //! To launch the interactive terminal application, simply run `galos`. //!```notrust -//! ---------------------------------------------------------------------------- -//! | Current Location: Ngalinn, Fall Station | -//! ---------------------------------------------------------------------------- -//! | Filter: +good:"Food and Water" -*M | -//! ---------------------------------------------------------------------------- -//! | [ ] Mannani | -//! | [x] Aitvas | -//! | [x] Sol | -//! | | -//! | | -//! | | -//! | | -//! | | -//! | | -//! | | -//! | | -//! | | -//! ---------------------------------------------------------------------------- -//! | Totals: Hyperspace 453Ly, | -//! ---------------------------------------------------------------------------- +//! ------------------------------------------- +//! | Current Location: Ngalinn, Fall Station | +//! ------------------------------------------- +//! | Filter: +good:"Food and Water" -*M | +//! ------------------------------------------- +//! | [ ] Mannani | +//! | [x] Aitvas | +//! | [x] Sol | +//! ------------------------------------------- +//! | Totals: Hyperspace 453Ly, | +//! ------------------------------------------- //!``` //! -//! ```notrust -//! Usage: galos ... -//! ``` -//! -//! -//! ##### `galos search [OPTIONS] ` +//! ### `galos search [OPTIONS] ` //! //! Search for systems, bodies, and stations in the database. This command shows a //! selection of details for each object found. @@ -59,7 +45,8 @@ //! ``` //! //! -//! ##### `galos route [ ]...` +//! ### `galos route [ ]...` +//! //! Plot routes between systems, bodies, and stations in the database. //! //! Where `op` is one of: @@ -78,7 +65,8 @@ //! //! TODO: Incorperate queries for both `+` and `|` nodes in the route. //! -//! ##### `galos-sync ` +//! ### `galos-sync ` +//! //! Syncs the DB with EDDN, EDSM and/or EDDB. //! //! Syncing from the `eddn` provider will subscribe to its ZMQ service and