aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ad78091
--- /dev/null
+++ b/README.md
@@ -0,0 +1,53 @@
+# Auzia-conky
+
+Auzia is a conky theme that displays system resources usage in rings.
+
+## Screenshots
+
+### For dark themes
+
+##### monochrome dark
+
+![monochrome dark](.github/monochrome_dark.jpg)
+
+##### blue dark
+
+![blue dark](.github/blue_dark.jpg)
+
+***
+
+### For light themes
+
+##### monochrome light
+
+![monochrome light](.github/monochrome_light.jpg)
+
+
+##### blue light
+
+![blue light](.github/blue_light.jpg)
+
+
+
+More colors schemes are available. Choose a color from the `settings.lua` file and restart conky to take effect.
+
+***
+
+## Download and Launch Auzia
+
+```sh
+git clone https://www.github.com/SZinedine/auzia-conky
+cd auzia-conky
+conky -c conkyrc
+```
+
+Edit `settings.lua` to choose your network interface, Internet speed and other settings.
+
+***
+
+## Dependencies
+
+- Conky 1.10+
+- cairo
+- imlib2
+