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
shilangyu
47cc34a8e2
reflected auto config creation
2020-03-02 22:07:41 +01:00
ClementTsang
59238c2687
Added named colour support + rgb colour support in config files.
2020-02-23 13:15:46 -05:00
ClementTsang
a756c44c66
Support average cpu colour separately from others. Redid documentation.
2020-02-23 00:30:00 -05:00
ClementTsang
0697d9dd56
Fix issue with default file paths not being respected; updated default file paths.
2020-02-20 23:10:52 -05:00
ClementTsang
6892ec6065
Update documentation again. One last build trigger.
2020-02-20 21:24:49 -05:00
ClementTsang
97c51ea1c2
Update documentation. Trigger build.
2020-02-19 23:35:54 -05:00
ClementTsang
c0fb2bac3f
[skip travis] Consistency in captialization.
2020-02-19 21:36:17 -05:00
ClementTsang
3824b22a50
[skip travis] More documentation updating. Moved compat. chart over to widgets section, rewording, and add note on colour issues on some terminals when setting custom colours.
2020-02-19 21:33:11 -05:00
ClementTsang
fd32de2774
Add default windows path.
2020-02-18 23:03:01 -05:00
ClementTsang
f7ab907b74
[skip travis] Update documentation with widget specifics; prepare for release soon...
2020-02-16 21:12:31 -05:00
ClementTsang
3224adf047
[skip travis] Add new documentation file; this is not filled out yet.
2020-02-15 18:16:52 -05:00
ClementTsang
59c0b3df62
[skip travis] Update documentation a bit.
2020-02-15 17:41:26 -05:00