From c0cbdab68809214befeed40c1243458a0b6c9c9f Mon Sep 17 00:00:00 2001 From: ClementTsang <34804052+ClementTsang@users.noreply.github.com> Date: Sun, 1 Jun 2025 00:57:18 -0400 Subject: [PATCH] some refactoring and docs stuff --- README.md | 10 +++++----- src/widgets/mod.rs | 22 +++++++++++++--------- src/widgets/temp_graph.rs | 1 - src/widgets/temperature_graph.rs | 1 + 4 files changed, 19 insertions(+), 15 deletions(-) delete mode 100644 src/widgets/temp_graph.rs create mode 100644 src/widgets/temperature_graph.rs diff --git a/README.md b/README.md index 5658919e..7ed42b79 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ For more details on supported platforms and known problems, check out [the docum bottom may work on a number of platforms that aren't officially supported. Note that unsupported platforms: -- Might not be tested in CI to build or pass tests (see [here](./.github/workflows/ci.yml) for checked platforms). +- Might not be tested in CI to build or pass tests ([checked platforms can be found here](./.github/workflows/ci.yml)). - Might not be properly tested by maintainers prior to a stable release. - May only receive limited support, such as missing features or bugs that may not be fixed. @@ -328,7 +328,7 @@ sudo xbps-install bottom ### Homebrew -Formula available [here](https://formulae.brew.sh/formula/bottom): +[Formula available here](https://formulae.brew.sh/formula/bottom): ```bash brew install bottom @@ -336,7 +336,7 @@ brew install bottom ### MacPorts -Available [here](https://ports.macports.org/port/bottom/): +[Available here](https://ports.macports.org/port/bottom/): ```bash sudo port selfupdate @@ -345,7 +345,7 @@ sudo port install bottom ### Chocolatey -Chocolatey packages are located [here](https://chocolatey.org/packages/bottom): +[Chocolatey packages are located here](https://chocolatey.org/packages/bottom): ```bash choco install bottom @@ -361,7 +361,7 @@ scoop install bottom ### winget -The winget package can be found [here](https://github.com/microsoft/winget-pkgs/tree/master/manifests/c/Clement/bottom): +[The winget package can be found here](https://github.com/microsoft/winget-pkgs/tree/master/manifests/c/Clement/bottom): ```bash winget install bottom diff --git a/src/widgets/mod.rs b/src/widgets/mod.rs index a9a7bf09..ffe50b9c 100644 --- a/src/widgets/mod.rs +++ b/src/widgets/mod.rs @@ -1,17 +1,21 @@ -pub mod battery_info; -pub mod cpu_graph; -pub mod disk_graph; -pub mod disk_table; -pub mod mem_graph; -pub mod network_graph; -pub mod process_table; -pub mod temp_graph; -pub mod temperature_table; +//! The "widgets" of bottom. + +mod battery_info; +mod cpu_graph; +mod disk_graph; +mod disk_table; +mod mem_graph; +mod network_graph; +mod process_table; +mod temperature_graph; +mod temperature_table; pub use battery_info::*; pub use cpu_graph::*; +pub use disk_graph::*; pub use disk_table::*; pub use mem_graph::*; pub use network_graph::*; pub use process_table::*; +pub use temperature_graph::*; pub use temperature_table::*; diff --git a/src/widgets/temp_graph.rs b/src/widgets/temp_graph.rs deleted file mode 100644 index bbb3d089..00000000 --- a/src/widgets/temp_graph.rs +++ /dev/null @@ -1 +0,0 @@ -//! Code for a temperature graph widget. \ No newline at end of file diff --git a/src/widgets/temperature_graph.rs b/src/widgets/temperature_graph.rs new file mode 100644 index 00000000..9f5bec14 --- /dev/null +++ b/src/widgets/temperature_graph.rs @@ -0,0 +1 @@ +//! Code for a temperature graph widget.