diff --git a/README.md b/README.md index 24ad0b8..19f1541 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,56 @@ # System monitor graph Desklet -Desklet for Cinnamon (desktop environment) to show graphs for system variables +Desklet to show graphs for the level of activity in various system variables including: CPU, memory, and disks. The desklet supports multiple instances with different system variables with the idea of presenting them in a uniform way. -# Inspiration -These are some of the projects where I took inspiration for this project: - -* [Disk Space](https://cinnamon-spices.linuxmint.com/desklets/view/39) -* [CPU Load](https://cinnamon-spices.linuxmint.com/desklets/view/44) -* [Simple system monitor](https://cinnamon-spices.linuxmint.com/desklets/view/29) -* [Network usage monitor](https://cinnamon-spices.linuxmint.com/desklets/view/15) -* [Top](https://cinnamon-spices.linuxmint.com/desklets/view/41) -* [Win10 Widgets](https://win10widgets.com/) +

+
+Four instances of the Desklet in action. +

-# Resources +This project has been inspired from other Desklets such as [Disk Space](https://cinnamon-spices.linuxmint.com/desklets/view/39), [CPU Load](https://cinnamon-spices.linuxmint.com/desklets/view/44), [Simple system monitor](https://cinnamon-spices.linuxmint.com/desklets/view/29), [Network usage monitor](https://cinnamon-spices.linuxmint.com/desklets/view/15), [Top](https://cinnamon-spices.linuxmint.com/desklets/view/41), and the [Rainmeter Win10 Widgets](https://win10widgets.com/). + +## Features +### Variables to monitor (v1.0 - May 2020) + +| System variable | Description | +| ----------- | ----------- | +| CPU | CPU usage in % | +| RAM | Used RAM as % of total, and in GB | +| HDD | % of I/O activity, and free and total space in the filesystem (partition) indicated by the user| + +Each variable is calculated every `Refresh interval` seconds (Min. 1 s, Max. 60 s.), and the graph shows the last `Duration of the graph` period (Min. 30 s, Max. 60 min). + +### Customizable visual elements +

+
+Settings for one instance of the system monitor graph Desklet. +

+ +### Screenshots +

+
+The Desklet is fully customizable. +

+
+ +

+
+A simple screenshot. +

+ +## TODO +- [ ] Bottom alignment of the text elements +- [ ] Right alignment of the third text elements +- [ ] Add % of use of GPU +- [ ] Add other variables such as network, CPU and GPU temperatures, battery levels for PC and peripherals. + +### Resources +This is my first Desklet and the first time using JavaScript. Below, some resources that I used for the development of this Desklet. * [cinnamon-spices-desklets](https://github.com/linuxmint/cinnamon-spices-desklets) * [JavaScript Tutorial](https://www.w3schools.com/js/default.asp) * [CJS: JavaScript bindings for Cinnamon](https://github.com/linuxmint/cjs) * [CJS the importer](http://lira.epac.to:8080/doc/cinnamon/cinnamon-tutorials/importer.html) -* [Applet, desklet and extension settings reference](https://projects.linuxmint.com/reference/git/cinnamon-tutorials/xlet-settings.html) and [here](https://projects.linuxmint.com/reference/git/cinnamon-tutorials/xlet-settings-ref.html) +* [Applet, desklet and extension settings reference](https://projects.linuxmint.com/reference/git/cinnamon-tutorials/xlet-settings.html) and [here](https://projects.linuxmint.com/reference/git/cinnamon-tutorials/xlet-settings-ref.html) * [GJS: JavaScript Bindings for GNOME](https://gitlab.gnome.org/GNOME/gjs/blob/master/doc/Home.md) and [here](https://gjs-docs.gnome.org/) * [GJS examples](https://github.com/optimisme/gjs-examples) * [Clutter API](https://gjs-docs.gnome.org/clutter4~4_api/) @@ -27,9 +60,3 @@ These are some of the projects where I took inspiration for this project: * Default [`desklet.js` in Cinnamon](https://github.com/linuxmint/cinnamon/blob/master/js/ui/desklet.js) * [Manual alpha blending](https://stackoverflow.com/questions/746899/how-to-calculate-an-rgb-colour-by-specifying-an-alpha-blending-amount) * [Cairo documentation](https://www.cairographics.org/documentation/) - -# Notes: -* `/bin/df` for disk space -* `iostat -px` for hdd usage - -#TODO: add dependencies