summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md59
1 files changed, 59 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..65dbe99
--- /dev/null
+++ b/README.md
@@ -0,0 +1,59 @@
+# System Monitor
+GNOME System Monitor is a GNOME process viewer and system monitor with an attractive,
+easy-to-use interface, It has features, such as a tree view for process dependencies,
+icons for processes, the ability to hide processes that you don't want to see,
+graphical time histories of CPU/memory/swap usage,
+the ability to kill/renice processes needing root access,
+as well as the standard features that you might expect from a process viewer.
+
+## License
+This project is licensed under the **GNU General Public License v2.0**. [Learn more](https://choosealicense.com/licenses/gpl-2.0/)
+
+## Building
+The steps described below show how to compile and install Gnome-System-Monitor from its source.
+
+### Install required dependencies
+To build the application, the following dependencies are required:
+
+#### apt-get (Debian/Ubuntu/derivatives - deb-based package management)
+Use the following command to install dependencies:
+`sudo apt-get install meson gettext appstream-util itstool libglibmm-2.4-dev libgtkmm-3.0-dev libgtop2-dev librsvg2-dev libxml2-dev libhandy-1-dev libsystemd-dev`
+
+#### dnf (Fedora/Centos/etc - rpm-based package management)
+Use the following command to install dependencies:
+`sudo dnf install meson gettext appstream itstool glibmm24-devel gtkmm30-devel libgtop2-devel librsvg2-devel libxml2-devel libhandy1-devel systemd-devel`
+
+#### Optional dependencies:
+- polkit - recommended
+- gksu2
+- libgnomesu
+- libselinux
+- lsb_release in PATH - recommended on linux
+- libwnck
+
+
+### Building and installing
+Before following the steps below, clone the repository and change to its working directory.
+
+##### Configure and create the build directory with Meson.
+`meson build`
+
+Where `build` is just a directory name, and is up to your chosing.
+##### Build the application - this compiles the source.
+`ninja -C build`
+
+##### Install the application on your system - required to run Gnome-System-Monitor.
+`ninja -C build install`
+
+### Cleanup
+
+##### Use the following command to clean up the build directory and remove old build files.
+`ninja -C build -t clean`
+
+##### Remove the build directory to rebuild from scratch.
+`rm -rf build`
+
+## Bugs
+
+Please file System-Monitor bugs at:
+https://gitlab.gnome.org/GNOME/gnome-system-monitor/issues