1 files changed, 39 insertions, 0 deletions
diff --git a/python/python3-glances/README b/python/python3-glances/README
new file mode 100644
index 0000000000..cedeacf97d
--- /dev/null
+++ b/python/python3-glances/README
@@ -0,0 +1,39 @@
+glances is a free (LGPL), cross-platform, curses-based system
+monitoring tool which aims to present a maximum of information in
+a minimum of space, ideally to fit in a classical 80x24 terminal,
+or larger for additional data. It can adapt the displayed information
+dynamically, depending on the terminal size. A client/server mode is
+also available and remote monitoring can be done via terminal or a
+web interface.
+
+glances is written in Python and uses the psutil library to fetch
+statistical values from key elements, like CPU, load average, memory,
+network, disks, file systems, processes, etc.
+
+OPTIONAL DEPENDENCIES
+
+* Available on SBo: python3-docker (for Docker monitoring support)
+elasticsearch (for Elastic Search export module) hddtemp (for HDD
+temperature monitoring support) influxdb (for InfluxDB export module)
+python3-netifaces (for IP plugin) python-prometheus_client (for the
+Prometheus export module) python3-py-cpuinfo (for Quicklook CPU info
+module) python3-pymdstat (for RAID support) python3-pyzmq (for ZeroMQ
+export module)
+
+* Needs python3 version: batinfo (for battery monitoring) bottle
+(for Web server mode) python3-pysnmp (for SNMP support) statsd (for
+StatsD export module)
+
+* Not available on SBo: bernhard (for Riemann export module)
+cassandra-driver (for Cassandra export module) chevron (for the action
+script feature) couchdb (for CouchDB export module) graphitesender
+(For the Graphite export module) kafka-python (for Kafka export
+module) nvidia-ml-pyi3 (for GPU plugin) pika (for RabbitMQ/ActiveMQ
+export module) potsdb (for OpenTSDB export module) pygal (for graph
+export module) pySMART.smartx (for HDD Smart support) sparklines (for
+the Quick Plugin sparklines option) wifi (for wifi plugin) zeroconf
+(for autodiscover mode)
+
+NOTE: When launching glances from a terminal with a bright background,
+the option '--theme-white' is recommended. More options are documented
+in the man page and in the file glances.conf.