Commit graph

162 commits

Author SHA1 Message Date
Clement Tsang
5548db6472
docs: bump mkdocs-material to 9.1.9 (#1127) 2023-05-05 01:06:56 -04:00
Clement Tsang
605314d44c
feature: add customizable process columns (#1115)
* feature: add customizable process columns

* Add some tests and actual logic

* more tests

* update changelog

* update config field

* even more tests

* update documentation

* more testing
2023-04-29 19:21:48 -04:00
Clement Tsang
d180617e7a
docs: update mkdocs-material to 9.1.8 (#1116) 2023-04-26 00:29:39 -04:00
Clement Tsang
1c95411494
feature: add current battery charging state, update field names (#1106) 2023-04-19 00:46:57 -04:00
Twan Stok
1b1e80ec3c
feature: add buffer and cache memory (#1063)
* First implementation of cache memory data collection, mostly copied from RAM and swap implementations

* First implementation of cache memory display, copied from RAM and swap implementations. placed cache as second in the list as it is more similar to the RAM than any other item in the list

* expanded comment to explain method.

* rustfmt

* all cache-related code excluded on windows, in the process refactored src/data_conversion.rs convert_mem_label() to convert a single label instead of all at once

* better factoring-out of cache memory logic to allow individual disabling

* added --enable_cache_memory flag, disabled cache memory collection by default

* renamed CCH to CHE
not sure how i messed that up

* changelog updated

* Added command line flag documentation

* updated config file documentation

* specified that buffer and cache memory display does not work on windows

* resolved merge conflicts

* added documentation to cache memory data collection

* capitalized Windows

* implemented missing canvas styling logic

* fixed misplaced no-windows flag

* reduced colour collisions, as cache colour was the same as the first GPU colour

* made FIFTH_COLOUR constant windows-only

* Revert "made FIFTH_COLOUR constant windows-only"

This reverts commit 72698f1dd7.

* made FIFTH_COLOUR constant non-windows-only

* minor fix for basic mode row count

* Update src/app/data_harvester/memory/sysinfo.rs

Co-authored-by: Clement Tsang <34804052+ClementTsang@users.noreply.github.com>

* Update src/canvas/widgets/mem_basic.rs

Co-authored-by: Clement Tsang <34804052+ClementTsang@users.noreply.github.com>

* updated default_config.toml

* formatting

---------

Co-authored-by: ClementTsang <34804052+ClementTsang@users.noreply.github.com>
2023-04-12 22:51:41 -04:00
Clement Tsang
7e0210c63e
docs: update mkdocs-material to 9.1.6 (#1089) 2023-04-08 01:33:51 -04:00
Clement Tsang
e4f9033ed8
docs: update mkdocs-material to 9.1.5 (#1084) 2023-04-04 00:35:43 -04:00
Clement Tsang
e36854641c
docs: bump mkdocs-material to 9.1.4 (#1081) 2023-03-30 03:37:50 -04:00
ClementTsang
9146c4f6dd
docs: update font issue troubleshooting header 2023-03-29 04:33:07 -04:00
Clement Tsang
4d61ca4d41
docs: add mention for braille font issues on Linux (#1080) 2023-03-29 00:40:26 -04:00
Clement Tsang
1fbe89be8b
docs: bump mkdocs-material to 9.1.3 (#1070) 2023-03-17 00:02:20 -04:00
Clement Tsang
ea318e83c9
docs: bump mkdocs-material to 9.1.0 (#1042) 2023-03-03 05:53:38 -05:00
Clement Tsang
2a1c4104fd
other: promote macOS aarch64 to official support (#1025)
Since I have a macOS M1 laptop to test on now, I think it's a good time
to bump it to be officially supported, especially since it's going
to be the main macOS platform for the foreseeable feature.
2023-02-19 01:12:13 -05:00
ClementTsang
a266dd74ec
docs: update contributing docs/links 2023-02-13 03:35:46 -05:00
Clement Tsang
c19f429d35
docs: update changelog and missing doc info (#1018) 2023-02-11 02:48:23 -05:00
Clement Tsang
88111de941
docs: bump mkdocs-material and mkdocs-material-extensions (#1013) 2023-02-05 23:54:24 -05:00
ClementTsang
9ed5df15bb
docs: add script to serve mkdocs locally 2023-02-04 04:58:16 -05:00
Clement Tsang
bce95c0d48
docs: update requirements.txt and bump to 3.11 (#1011) 2023-02-03 03:25:25 -05:00
Clement Tsang
a94a8059da
docs: add docs on process kill, update docs on updating docs (#1010)
* docs: add some documentation on process term, update captions

* docs on updating docs
2023-02-03 03:05:18 -05:00
ClementTsang
32434932a6
docs: update some packaging/distribution docs with more details 2023-01-26 21:37:09 -05:00
Clement Tsang
22e386a38c
other: re-enable disk usage split, update help menu (#963)
* Revert "other: revert disk usage change for now (#962)"

This reverts commit d3661c2320.

* some cleanup

* update help menu

* update screenshot

* update changelog wording

* Remove redundant newlines

* Use type system to ensure help constants match in size
2023-01-19 05:40:34 -05:00
Rareș Constantin
f8db3403af
other: Dynamic battery widget (#975)
* Added dynamic battery widget

For bottom to know that there are no batteries on the system,
I added the battery::Manager to the options.rs file because
here is the first moment bottom verifies battery configuration
by reading the config file, which may or may not contain the
battery field, but for a better UX, it doesn't matter what bottom
finds in the config file now, if it doesn't retrieve battery data,
it just ignores the battery widget all together.
If needed, it can be adjusted so that if the config file contains
the battery field, it will still show the widget.

* CFG guarding for BATTERY module

I guarded the options.rs in two places for battery module that can be missing in the feature list.

Co-authored-by: RaresCon <RaresCon>
Co-authored-by: NitrogenDev <44950964+NitrogenDev@users.noreply.github.com>
2023-01-15 12:06:42 -05:00
Clement Tsang
768ec9cb36
docs: update screenshots for 0.7.1 (#964) 2023-01-05 23:45:17 -05:00
Clement Tsang
33afeb68c3
docs: make stable docs the default (#958) 2023-01-05 21:08:17 -05:00
Clement Tsang
07fd2152f4
docs: update changelog + docs for default expansion feature (#928) 2022-12-07 04:28:43 -05:00
ClementTsang
541867e5af
docs: clean up command line flag docs 2022-11-22 05:15:15 -05:00
Clement Tsang
4f00434210
other: non-normalized process CPU% cleanup and docs (#910)
* refactor: simplify non-normalized code

* update docs

* appease clippy

* add comment

* unnormalized

* fix issues on non-Linux regarding typos/imports
2022-11-21 05:28:42 -05:00
Clement Tsang
50768907ec
feature: add custom retention periods for data (#892)
* feature: add custom retention periods for data

* docs: update changelog

* docs: update docs
2022-11-13 01:51:10 -05:00
Clement Tsang
f41e7cd66d
ci: unify cache keys in actions (#890)
* ci: unify cache keys in actions

* some docs

* because empty strings are false in JS

* update comment

* fix build cache naming
2022-11-11 23:45:27 -05:00
Clement Tsang
938c4ccd52
feature: search paste support (#881)
* feature: add pasting to search

Supports pasting events to the search bar (e.g. shift-insert, ctrl-shift-v).

* update docs

* clippy

* comment

* Update process.md

* remove keyboard event throttle

* fix issues with cjk/flag characters
2022-11-10 00:40:04 -05:00
Clement Tsang
e1be318177
docs: update usage and config, add blurb in home (#876)
* docs: update usage and config, add blurb in home

* add doc pages to pr template
2022-11-07 23:36:27 -05:00
Clement Tsang
76d2e83efa
docs: add a quick blurb on doc site of what bottom is (#875) 2022-11-07 02:44:30 -05:00
Clement Tsang
2b3c76bf5a
docs: update docs for disk sorting feature (#871)
* update changelog

* update mkdocs
2022-11-06 02:26:36 -05:00
Clement Tsang
4d9f5093b2
feature: basic sortable temp (#868)
* feature: basic sortable temp

* add shortcuts

* fix missing shortcut names in header

* update changelog

* update docs
2022-11-05 19:32:14 -04:00
Clement Tsang
99a353bade
docs: update docs lib versions as of 2022-10-29 (#857)
Updates the following document building libraries:

- `mkdocs` (1.3.1 -> 1.4.1)
- `mkdocs-material` (8.5.3 -> 8.5.7)
- `mkdocs-material-extensions` (1.0.3 -> 1.1.0)
2022-10-29 04:21:05 -04:00
Justin Martin
dd003101a0
enable gpu mem cli and update docs for arc/gpu mem (#836) 2022-10-16 00:08:38 -04:00
Clement Tsang
c4d164cfe1
docs: update mkdocs-material to 8.5.3 (#819) 2022-09-29 02:28:27 -04:00
ClementTsang
10efe75fbd
docs: update some contribution documentation 2022-09-16 05:16:58 -04:00
Clement Tsang
c6c7fb3a30
deps: update sysinfo to 0.26.2 (#806)
* deps: update sysinfo to 0.26.2

This dependency update has some nice things in store for us:
- MacOS M1 temperature support
- Bevy of bug fixes

* update documentation

* some fixes
2022-09-16 04:42:24 -04:00
Clement Tsang
5973e6db72
docs: adjust dev doc file structure, add build and deploy docs (#804)
* docs: add separate section on development

* docs: update instructions on writing docs

* docs: add build and deploy docs
2022-09-12 04:14:19 -04:00
Clement Tsang
14808b3a2e
ci: completion/manpage generation script spring cleaning (#795)
* ci: spring cleaning of completions autogen

This commit changes a few things/cleans up stuff:
- Completion and manpage generation now drops the files off in
  `./target/tmp/bottom` rather than arbitrarily in the build directory.
  This was originally done because I was lazy and just needed it to work
  in CI, but it's kinda gross if you want to build the manpages in your
  own directory.
- CI was updated to handle this.
- Only run if the `BTM_GENERATE` env var is actually non-empty.

* docs: update for manpage/completion gen

* ci: auto delete autogen comp/manpage dir

* ci: fix incorrect mv for autogen

The mv was too late, should be earlier in the workflow.

* ci: specify shell in autogen delete

* docs: more updates to manpage/comp docs

* ci: unify env vars

* ci: skip autogen on build-msi
2022-08-30 18:25:16 -04:00
Clement Tsang
1d0801ce71
docs: update mkdocs-material to 8.4.0 (#788) 2022-08-19 19:07:36 -04:00
ClementTsang
582cd308eb
docs: add half-page scroll shortcut to docs 2022-08-14 17:51:04 -04:00
ClementTsang
83284e2dba docs: edit docs regarding M1 macOS support 2022-08-13 11:31:29 -04:00
xgdgsc
bc74e0b73b
docs: fix dead link (#771) 2022-07-26 14:08:03 -04:00
Clement Tsang
39f04fb22c
docs: mention FreeBSD works (#769)
Update some documentation to mention (currently unofficialish) FreeBSD support.
2022-07-24 06:53:34 -04:00
Clement Tsang
31bd2ca19f
docs: bump mkdocs to fix markdown breaking exts (#770)
The markdown Python lib seems to be causing some issues with certain
extensions. Bumping mkdocs to 1.3.1 seems to resolve this issue (the
alternative is pinning markdown to < 8.4.0).
2022-07-24 06:50:52 -04:00
Clement Tsang
d3a187b529
docs: bump mkdocs-material to 8.3.9 (#762) 2022-07-07 05:30:49 -04:00
Clement Tsang
4fa1fc7f58
docs: bump mkdocs-material to 8.3.8 (#753)
Bumps mkdocs-material to 8.3.8, which contains some bug fixes.
2022-06-24 20:24:40 -04:00
Clement Tsang
372659094b
docs: bump mkdocs-material to 8.3.5 (#751)
Bumps mkdocs-material to 8.3.5 (https://github.com/squidfunk/mkdocs-material/releases/tag/8.3.5).
2022-06-15 03:46:48 -04:00
Clement Tsang
122373aff7
docs: bump mkdocs-material to 8.3.3 (#748)
Bumps mkdocs-material to version 8.3.3.

See https://github.com/squidfunk/mkdocs-material/releases/tag/8.3.3 for more details
2022-06-08 21:39:16 -04:00
Clement Tsang
c6ae6913fc
docs: bump mkdocs material to 8.2.15 (#735) 2022-05-23 20:11:21 -04:00
ClementTsang
45680dafcf docs: clean up troubleshooting page again 2022-05-07 20:01:11 -04:00
Clement Tsang
a26cffce05
docs: update mkdocs-material to 8.2.13 (#727) 2022-05-07 19:57:12 -04:00
ClementTsang
c09322fdc2 docs: add even more troubleshooting documentation 2022-05-07 19:48:32 -04:00
ClementTsang
4d507d1793 docs: add more troubleshooting documentation 2022-05-07 19:38:37 -04:00
Clement Tsang
08bb933f38
docs: add some search features to mkdocs config (#704)
Enables some search features for the mkdocs config.
2022-04-11 03:54:21 -04:00
Clement Tsang
7c62822732
docs: update mkdocs-material to 8.2.9 (#701) 2022-04-10 23:57:42 -04:00
Clement Tsang
747497cc8a
docs: mention discussions, fix broken link, update mkdocs req (#698)
Fixes a broken link, and mention when to use discussions over issues. Also updates mkdocs in the build process due to some broken dependencies.
2022-03-27 21:57:55 -04:00
Clement Tsang
61c8bfd574
docs: add a line to feature request docs/template (#666)
Just adds an extra line to the template/docs to check if an existing issue already exists.
2022-01-29 14:49:41 -05:00
Clement Tsang
1237a35663
docs: update app descriptions (#659)
Update app descriptions across the board to be more consistent.
2022-01-19 23:49:11 -05:00
Clement Tsang
f35718b580
docs: add section on WSL in Linux known issues, update links (#653)
Update support links in documentation; add section on WSL in Linux known issues.
2021-12-31 16:50:40 -05:00
Clement Tsang
9eabb061aa
feature: add basic page up/down scrolling (#646)
Adds page up/down scrolling support to respectively scroll up/down by a full page.

Note that this is mostly just to get the feature out for those interested, and is admittedly a bit rushed - I will be rewriting all logic involving event handling as part of state refactor anyways, so this will also get changed in the work done there, and therefore, I kinda just sped through this.
2021-12-27 18:23:11 -05:00
Clement Tsang
3fefcdbb11
docs: Update mkdocs file layout and config (#642)
Updates some settings regarding mkdocs. Main changes:

* Separate out support into two separate pages
* Move ToC as part of navigation
2021-12-22 18:03:33 -05:00
Clement Tsang
9a11ead991
ci: Use commit hash for some actions to pin them (#641)
Pins some actions using a specific commit hash.
2021-12-22 17:29:50 -05:00
Clement Tsang
78848ea968
docs: update mkdocs requirements (#634)
Updates the dependencies for mkdocs-related stuff.
2021-12-19 16:43:13 -05:00
Clement Tsang
a42b2cf6c8
docs: revert CFP for now (#633)
There were some weird interactions that I'm not sure about (like if you do bottom.pages.dev/asdf/ it infinitely redirects...?), so I'll revert for now.
2021-12-19 15:42:22 -05:00
Clement Tsang
8e5742d636
docs: try switching over to Cloudflare Pages (#632)
I would prefer for the project to not be under clementtsang.github.io/bottom, so let's try out CFP.
2021-12-19 15:26:10 -05:00
Clement Tsang
a629e33f2d
docs: change contribution wording in docs page a bit (#614)
Tiny wording changes.
2021-11-27 06:41:54 -05:00
ClementTsang
175abf5db0 docs: small wording change 2021-11-27 05:31:32 -05:00
Clement Tsang
65d3dd7af5
ci: simplify python dependency step for release/doc pipeline (#596)
Slightly simplifies the whole Python dependency step for pipelines generating mkdocs.
2021-10-10 18:16:21 -04:00
ClementTsang
96ca024acc docs: break broken image link for sample layout 2021-09-25 22:11:10 -04:00
Clement Tsang
7e71832d10
bug: remove incorrect shortcut from docs/help (#589)
Removes an incorrect shortcut. No idea when that got there.
2021-09-25 20:28:41 -04:00
Clement Tsang
ed07fbe1cc
other: Make the battery dependency/features optional (#570)
Allows disabling of the battery dependency through a feature flag. This also aims to disable all related features.
2021-08-19 22:16:44 -04:00
Clement Tsang
f185c09c7e
docs: update home page text 2021-08-13 22:28:31 -04:00
Clement Tsang
2dddfcc962
docs: update edit link for doc site 2021-08-04 11:49:55 -04:00
ClementTsang
76cf7770f2 docs: fix typo 2021-07-31 16:25:38 -04:00
Clement Tsang
cb680dd12e
other: Add RISC-V to unofficially supported targets (#565)
Adds CI actions and documentation for RISC-V.
2021-07-31 16:24:16 -04:00
Clement Tsang
bacaca5548
change: add '/s' to network usage legend (#557)
Adds "/s" to the the network usage graph legend.
2021-07-23 19:51:45 -04:00
ClementTsang
a7464d25af docs: update a line in the docs 2021-07-22 14:39:14 -04:00
Clement Tsang
e0f66fee98
docs: fix broken image link in data filtering (#553)
Fixes broken links in the documentation site.
2021-07-19 04:14:02 -04:00
Clement Tsang
2736dc9b35
refactor: switch to manual implementation of meminfo parse (#548)
Manually parse `/proc/meminfo` for the purposes of memory usage.
2021-07-17 22:27:40 -04:00
Clement Tsang
7f24e62867
bug: switch over to procfs for linux mem usage (#547)
Swap to manually calculating the mem total and usage via procfs. The usage calculation is now:

total - (free + cached + buffers + slab_reclaimable - shmem)

This follows the same usage calculation as htop. See the PR for more details.
2021-07-17 21:25:05 -04:00
Clement Tsang
b0199d4d1c
bug: scaling -> scale in some docs, help, and config (#543)
Just fixing a few typos.
2021-07-14 19:30:32 -04:00
Clement Tsang
968b7bb2de
bug: Fix missing config options in docs and default config (#542)
Adds the missing hide_time and battery config option to the default config and corresponding documentation.

Should probably automate the generation of this somehow tbh, though this might change when I add in-app config (soon™)
2021-07-14 19:08:54 -04:00
Clement Tsang
f13905f78d
docs: Fix typo and clarify in troubleshooting step for points (#532) 2021-07-01 18:16:28 -04:00
ClementTsang
c628645816 docs: Fix typo 2021-06-27 20:55:39 -04:00
ClementTsang
6a5a8945ed docs: Add a section in troubleshooting on snap 2021-06-27 20:40:47 -04:00
Clement Tsang
34541a4844
docs: update old documentation links (#522) 2021-06-24 00:13:24 -04:00
Clement Tsang
b67c928f2b
docs: Switch to mike for versioning (#521)
Switches to mike to add versioning to docs.
2021-06-23 23:34:39 -04:00
Clement Tsang
93b899e745
feature: add F9 as an alternative process kill key (#518)
Adds F9 as an alternative kill shortcut to dd.
2021-06-22 20:34:00 -04:00
Clement Tsang
8f365afc33
docs: add some links to the documentation (#517)
Adds some links to the docs in the README and feature request template.
2021-06-22 10:14:26 -04:00
Clement Tsang
f1e2789b26
docs: Switch to webp, fix some sections (#514)
Switches to webp and fixes some typos/poor wording.
2021-06-21 22:53:25 -04:00
Clement Tsang
b89990db9a
docs: Touch up some photos (#511) 2021-06-21 22:35:19 -04:00
ClementTsang
a3660bd27e docs: Change wording in main page for one line 2021-06-21 11:31:21 -04:00
imgbot[bot]
27009b5c75
docs: [ImgBot] Optimize images (#508)
*Total -- 2,850.89kb -> 2,439.82kb (14.42%)

/docs/content/assets/screenshots/process/process_tree.png -- 285.48kb -> 237.31kb (16.87%)
/docs/content/assets/screenshots/process/process_full.png -- 254.23kb -> 212.29kb (16.5%)
/docs/content/assets/screenshots/basic.png -- 281.83kb -> 235.41kb (16.47%)
/docs/content/assets/screenshots/process/process_sort_menu.png -- 288.35kb -> 241.01kb (16.42%)
/docs/content/assets/screenshots/process/process_default.png -- 271.25kb -> 227.63kb (16.08%)
/docs/content/assets/screenshots/process/search/quotes.png -- 263.86kb -> 222.42kb (15.7%)
/docs/content/assets/screenshots/process/search/or.png -- 97.11kb -> 82.43kb (15.12%)
/docs/content/assets/screenshots/process/process_grouped.png -- 178.66kb -> 153.12kb (14.3%)
/docs/content/assets/screenshots/network/network_old.png -- 168.70kb -> 145.37kb (13.83%)
/docs/content/assets/screenshots/troubleshooting/dots.png -- 171.26kb -> 148.07kb (13.54%)
/docs/content/assets/screenshots/temperature.png -- 54.51kb -> 47.39kb (13.06%)
/docs/content/assets/screenshots/process/search/cpu.png -- 49.89kb -> 43.78kb (12.25%)
/docs/content/assets/screenshots/disk.png -- 48.72kb -> 42.78kb (12.18%)
/docs/content/assets/screenshots/process/search/regex.png -- 45.85kb -> 40.36kb (11.99%)
/docs/content/assets/screenshots/process/search/search.png -- 39.77kb -> 35.13kb (11.66%)
/docs/content/assets/screenshots/battery.png -- 30.00kb -> 27.14kb (9.52%)
/docs/content/assets/screenshots/troubleshooting/weird_braille.png -- 59.55kb -> 54.29kb (8.83%)
/docs/content/assets/screenshots/network/network.png -- 29.21kb -> 26.68kb (8.65%)
/docs/content/assets/screenshots/troubleshooting/no_braille.png -- 158.67kb -> 147.71kb (6.91%)
/docs/content/assets/screenshots/cpu.png -- 48.80kb -> 45.56kb (6.64%)
/docs/content/assets/screenshots/memory.png -- 25.21kb -> 23.95kb (5.01%)

Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>

Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>
2021-06-21 02:09:13 -04:00
ClementTsang
8f6284581d docs: Fix some missing text in docs 2021-06-21 02:03:10 -04:00
Clement Tsang
06071d5abf
docs: migrate documentation over to mkdocs (#506)
A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs.

Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 01:40:58 -04:00
ClementTsang
99516ca143 chore: Delete docs folder and update lock 2020-04-09 15:28:43 -04:00
Clement Tsang
0b1d84fdf5
Add modularity to widget placement and inclusion (#95) 2020-04-01 20:31:43 -04:00