Merge pull request #58 from derenv/readme_update

migrated docs from obsidian

Author: derenv

.github/FUNDING.yml

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2022 Deren Vural
+# SPDX-License-Identifier: GPL-3.0-or-later
+
 # These are supported funding model platforms
 
 github: derenv # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,3 +1,7 @@
+<!--
+SPDX-FileCopyrightText: 2022 Deren Vural
+SPDX-License-Identifier: GPL-3.0-or-later
+-->
 ---
 name: Bug report
 about: Create a report to help us improve

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,3 +1,7 @@
+<!--
+SPDX-FileCopyrightText: 2022 Deren Vural
+SPDX-License-Identifier: GPL-3.0-or-later
+-->
 ---
 name: Feature request
 about: Suggest an idea for this project

.github/ISSUE_TEMPLATE/report-a-security-vulnerability.md

@@ -1,3 +1,7 @@
+<!--
+SPDX-FileCopyrightText: 2022 Deren Vural
+SPDX-License-Identifier: GPL-3.0-or-later
+-->
 ---
 name: Report a security vulnerability
 about: Please review our [security policy](https://github.com/derenv/gtk4-nvidia-monitor-rust/security/policy)

README.md

@@ -3,71 +3,70 @@ SPDX-FileCopyrightText: 2022 Deren Vural
 SPDX-License-Identifier: GPL-3.0-or-later
 -->
 
-# Description
-
-[![wakatime](https://wakatime.com/badge/user/8ce81774-1d46-4c72-8a15-b5cf4032138f/project/64d5b278-0a3f-4b93-9a34-5cf88c7a8a3a.svg)](https://wakatime.com/badge/user/8ce81774-1d46-4c72-8a15-b5cf4032138f/project/64d5b278-0a3f-4b93-9a34-5cf88c7a8a3a)
+[![wakatime](https://wakatime.com/badge/user/8ce81774-1d46-4c72-8a15-b5cf4032138f/project/64d5b278-0a3f-4b93-9a34-5cf88c7a8a3a.svg)](https://wakatime.com/badge/user/8ce81774-1d46-4c72-8a15-b5cf4032138f/project/64d5b278-0a3f-4b93-9a34-5cf88c7a8a3a) ![CI](https://github.com/derenv/gtk4-nvidia-monitor-rust/actions/workflows/rust.yml/badge.svg) [![Test Coverage](https://codecov.io/gh/derenv/gtk4-nvidia-monitor-rust/branch/main/graph/badge.svg?token=PHDU5O3VFZ)](https://codecov.io/gh/derenv/gtk4-nvidia-monitor-rust)[![License: GPL v3.0+](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)
 
-![CI](https://github.com/derenv/gtk4-nvidia-monitor-rust/actions/workflows/rust.yml/badge.svg)
+# Description
+Initially intended as a rewrite of [gnome-nvidia-extension](https://github.com/ethanwharris/gnome-nvidia-extension) as a practise Rust project, this app has developed into a tool for interacting with GPU management interfaces like Nvidia's [nvidia-settings](https://github.com/NVIDIA/nvidia-settings), [nvidia-smi](https://developer.nvidia.com/nvidia-system-management-interface) and [optimus](https://www.nvidia.com/en-gb/geforce/technologies/optimus/). This includes viewing statistics like temperature, clock speeds, VRAM usage but also setting fan-profiles and GPU overclocks (like [GreenWithEnvy](https://gitlab.com/leinardi/gwe/), a major inspiration for this app).
 
-[![Test Coverage](https://codecov.io/gh/derenv/gtk4-nvidia-monitor-rust/branch/main/graph/badge.svg?token=PHDU5O3VFZ)](https://codecov.io/gh/derenv/gtk4-nvidia-monitor-rust)
+The intention is to replace both GPU overclocking software like [GreenWithEnvy](https://gitlab.com/leinardi/gwe/) and system tray monitoring programs/extensions like [gnome-nvidia-extension](https://github.com/ethanwharris/gnome-nvidia-extension) with a single interface, to simplify GPU management. Hopefully the app can be extended to AMD's equivalent GPU management interfaces (if they exist) at some point (see the [Roadmap](docs/ROADMAP.md) for the rest of the plan for this app)
 
-This project is a rewrite of gnome-nvidia-extension in Rust - intended as a practise Rust project.
+The app is written entirely in [gtk-rs](https://gtk-rs.org/), using [gtk4](https://github.com/gtk-rs/gtk4-rs) and [libadwaita](https://world.pages.gitlab.gnome.org/Rust/libadwaita-rs/).
 
 # Usage
+To first install/update the settings schema, use the following:
+```bash
+bash install_schemas.sh
+```
 
-Use the following to compile the project:
+Then, use the following to compile the project:
+```bash
+cargo clean; cargo build
+```
 
+Finally, run the app:
 ```bash
-cargo clean; cargo run
+cargo run
 ```
 
 # Resources
-
-## Original Extension
-
-[Original version, written in GTK-JS](https://github.com/ethanwharris/gnome-nvidia-extension)
-
+## Applications
+- [Original version, written in GTK-JS](https://github.com/ethanwharris/gnome-nvidia-extension)
+- [nvidia-settings](https://github.com/NVIDIA/nvidia-settings)
+- [nvidia-smi](https://developer.nvidia.com/nvidia-system-management-interface)
+- [optimus](https://www.nvidia.com/en-gb/geforce/technologies/optimus/)
+- [GreenWithEnvy (GWE)]()
 ## Documentation
-
 - [GTK-RS Project website](https://gtk-rs.org/)
 - [GTK-RS Book](https://gtk-rs.org/gtk4-rs/stable/latest/book/introduction.html)
 - [GTK-RS Documentation](https://gtk-rs.org/gtk-rs-core/stable/latest/docs/)
 - [GLib Documentation](https://docs.gtk.org/glib/index.html)
 - [GObject Documentation](https://docs.gtk.org/gobject/index.html)
-
-## GitHub
-
+- [Gio Documentation](https://docs.gtk.org/gio/index.html)
+- [LibAdwaita-rs Documentation](https://relm4.org/docs/stable/libadwaita/index.html)
+- [Gnome HIG](https://developer.gnome.org/hig/index.html)
+## Git
 - [GTK-RS Organisation on GitHub](https://github.com/gtk-rs)
 - [GTK-RS Core](https://github.com/gtk-rs/gtk-rs-core)
-- [GTK3-RS](https://github.com/gtk-rs/gtk3-rs)
 - [GTK4-RS](https://github.com/gtk-rs/gtk4-rs)
+- [LibAdwaita-rs](https://world.pages.gitlab.gnome.org/Rust/libadwaita-rs/)
 
 ## Crates
-
 ### GTK libraries
+- [gtk4](https://crates.io/crates/gtk4)
+- [gdk4](https://crates.io/crates/gdk4)
+- [gtk4-macros](https://crates.io/crates/gtk4-macros)
+- [LibAdwaita](https://crates.io/crates/libadwaita)
 
-- [GTK4](https://crates.io/crates/gtk4)
-- [GLib](https://crates.io/crates/glib/0.15.12)
-- [Gio](https://crates.io/crates/gio/0.15.12)
-
+## Examples & Discussion
+These are intended as pointers for others creating gtk-rs projects, as they took a while to wrap my head around (or i haven't yet).
 ### System Tray Library
-
-[libappindicator](https://crates.io/crates/libappindicator/0.7.1)
-
-There are other ways of doing this - libappindicator seems broken..
-
-## Examples
-
-- [GObject Subclassing (GTK3)](https://github.com/gtk-rs/gtk3-rs/tree/master/examples/basic_subclass)
-- [GObject Subclassing (GTK4)](https://github.com/gtk-rs/gtk4-rs/tree/8b0c4cbd35912b9f8685d40f796b0806c52119ab/book/listings/todo/1)
-- [System Tray (libappindicator)](https://github.com/tauri-apps/libappindicator-rs/blob/main/examples/hello.rs)
-
-## System Tray Discussion
-
-[Reddit Post](https://www.reddit.com/r/gnome/comments/7x7qc6/by_what_logic_was_system_tray_removed/)
-
-The post above has possible alternatives to libappindicator in the comments
+(see [System Tray](docs/system_tray.md) for discussion)
+### Subclassing
+(see [Subclassing](docs/subclassing.md) for discussion)
+### Async
+(see [Async](docs/async.md) for discussion)
+### Signals
+(see [Signals](docs/signals.md) for discussion)
 
 # License
-
-[![License: GPL v3.0+](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)
+The app is licensed under [GPL3.0-or-later](https://spdx.org/licenses/GPL-3.0-or-later.html)

SECURITY.md

@@ -1,3 +1,7 @@
+<!--
+SPDX-FileCopyrightText: 2022 Deren Vural
+SPDX-License-Identifier: GPL-3.0-or-later
+-->
 # Security Policy
 
 ## Supported Versions

docs/CODE_OF_CONDUCT.md

@@ -1,3 +1,7 @@
+<!--
+SPDX-FileCopyrightText: 2022 Deren Vural
+SPDX-License-Identifier: GPL-3.0-or-later
+-->
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge

docs/CONTRIBUTING.md

@@ -1,3 +1,7 @@
+<!--
+SPDX-FileCopyrightText: 2022 Deren Vural
+SPDX-License-Identifier: GPL-3.0-or-later
+-->
 # Welcome to gtk4-nvidia-monitor-rust contributing guide
 
 Thank you for investing your time in contributing to our project!
@@ -24,7 +28,7 @@ Issues tagged "good first issue" and "help wanted" are your best bet - otherwise
 
 #### Create a new issue
 
-If you spot a bug or want a new feature, [search if an issue already exists](https://github.com/derenv/gtk4-nvidia-monitor-rust/issues). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/derenv/gtk4-nvidia-monitor-rust/issues/new/choose). 
+If you spot a bug or want a new feature, [search if an issue already exists](https://github.com/derenv/gtk4-nvidia-monitor-rust/issues). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/derenv/gtk4-nvidia-monitor-rust/issues/new/choose).
 
 #### Solve an issue
 
@@ -34,7 +38,7 @@ Scan through our [existing issues](https://github.com/derenv/gtk4-nvidia-monitor
 
 #### Make changes in the UI
 
-Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review. 
+Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review.
 
 #### Make changes locally
 
@@ -57,7 +61,7 @@ Commit the changes once you are happy with them.
 ### Pull Request
 
 When you're finished with the changes, create a pull request, also known as a PR.
-- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request. 
+- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
 - Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
 - Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge.
 Once you submit your PR, a team member will review your proposal. We may ask questions or request additional information.

docs/ROADMAP.md

@@ -0,0 +1,61 @@
+<!--
+SPDX-FileCopyrightText: 2022 Deren Vural
+SPDX-License-Identifier: GPL-3.0-or-later
+-->
+
+# Roadmap
+
+- [x] Basic Functionality
+- [ ] Match GWE Functionality
+	- [ ] Full statistics
+	- [ ] Add fan-curve support
+	- [ ] Add clock speed support
+- [ ] Improve on GWE Functionality
+	- [ ] Customizable tabs/views of statistics
+        - [x] Can set name of each tab/view
+        - [x] Can set the list of properties in each tab/view
+        - [x] Can re-order list of properties in each tab/view
+        - [ ] Can set icon of each tab/view
+    - [ ] Better overclocking support
+- [ ] Improve settings application support
+	- [x] Add ability to open settings app
+	- [ ] Add ability to set settings application in the app settings
+- [ ] Add provider application support
+	- [x] Add ability to set provider application in the app settings
+	- [x] nvidia-settings (Nvidia)
+	- [x] nvidia-smi (Nvidia)
+	- [x] optimus (Nvidia)
+		- [ ] Cover bug described [here](https://github.com/ethanwharris/gnome-nvidia-extension/issues/206)
+	- [ ] Find suitable AMD-based app
+
+## Basic Functionality
+match old extension, basic design of app
+
+## Full Statistics
+match GWE
+
+## Add fan-curve support
+match GWE
+
+## Add Clock speed support
+match GWE
+
+## Customizable Tabs of Statistics
+i.e. improve on GWE
+
+## Improve settings app support
+Can open settings app (nvidia-settings), this should be set within the app settings.
+
+## Improve provider app support
+### Nvidia
+Currently, the app allows interacting with GPU management interfaces like Nvidia's [nvidia-settings](https://github.com/NVIDIA/nvidia-settings) and [nvidia-smi](https://developer.nvidia.com/nvidia-system-management-interface), and [optimus](https://www.nvidia.com/en-gb/geforce/technologies/optimus/).
+
+#NOTE There is an issue in the [original extension](https://github.com/ethanwharris/gnome-nvidia-extension) with nvidia-settings and nvidia-smi (and thus also optimus) where fan speed is unavailable to query and thus breaks the functionality of the extension. This highlights an issue - what to do if results given by the provider are invalid? How can we check this when modifying GPU views so that the user cannot add invalid statistics? Should the statistic instead show an error message (i.e. "This statistic is not valid for this GPU..")?
+
+### AMD
+Hopfully we can support some equivalent provider for AMD, for example [radeon-profile](https://github.com/marazmista/radeon-profile), a GPU management interface developed by [marazmista](https://github.com/marazmista) (though it has not been updated since 2020...).
+
+#NOTE This will require a name change!
+
+### Mesa/Nouveau
+Currently no research has been done re the open source drivers, as to my knowledge there are no equivalent GPU management interfaces for these.

docs/async.md

@@ -0,0 +1,11 @@
+<!--
+SPDX-FileCopyrightText: 2022 Deren Vural
+SPDX-License-Identifier: GPL-3.0-or-later
+-->
+
+# Description
+TODO: ???
+
+# Resources
+## Examples
+TODO: ???