Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-12-27 04:32:55 +00:00
Code Issues Releases Activity

Update README with contribution notes.

Browse Source
This commit is contained in:
Brenden Matthews 2019-03-03 10:27:07 -05:00
parent c352069b31
commit 1d409379ab
1 changed files with 38 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
README.md
View File

@ -9,28 +9,28 @@ any kind of information on your desktop.
[📹 An introduction to Conky (YouTube)](https://www.youtube.com/watch?v=bHtpLEoRKmg&t=19s).
### Features
## Features
Conky can display more than 300 built-in objects, including support for:
* A plethora of OS stats (uname, uptime, **CPU usage**, **mem
usage**, disk usage, **"top"** like process stats, and **network
monitoring**, just to name a few).
* Built-in **IMAP** and **POP3** support.
* Built-in support for many popular music players ([MPD][],
[XMMS2][], [Audacious][]).
* Can be extended using built-in [**Lua**](lua) support, or any of your
own scripts and programs ([more](https://github.com/brndnmtthws/conky/wiki#tutorial)).
* Built-in [**Imlib2**][Imlib2] and [**Cairo**][cairo] bindings for arbitrary drawing
with Lua ([more](https://github.com/brndnmtthws/conky/wiki/Lua)).
* Runs on Linux, FreeBSD, OpenBSD, DragonFlyBSD, NetBSD, Solaris, Haiku OS, and macOS!
- A plethora of OS stats (uname, uptime, **CPU usage**, **mem
usage**, disk usage, **"top"** like process stats, and **network
monitoring**, just to name a few).
- Built-in **IMAP** and **POP3** support.
- Built-in support for many popular music players ([MPD][],
[XMMS2][], [Audacious][]).
- Can be extended using built-in [**Lua**](lua) support, or any of your
own scripts and programs ([more](https://github.com/brndnmtthws/conky/wiki#tutorial)).
- Built-in [**Imlib2**][imlib2] and [**Cairo**][cairo] bindings for arbitrary drawing
with Lua ([more](https://github.com/brndnmtthws/conky/wiki/Lua)).
- Runs on Linux, FreeBSD, OpenBSD, DragonFlyBSD, NetBSD, Solaris, Haiku OS, and macOS!
... and much much more.
Conky can display information either as text, or using simple progress
bars and graph widgets, with different fonts and colours.
### Screenshots
## Screenshots
[![screenshot](https://github.com/brndnmtthws/conky/wiki/configs/brenden/screenshot-thumb.png)](https://raw.github.com/wiki/brndnmtthws/conky/configs/brenden/screenshot.png)
[![screenshot](https://github.com/brndnmtthws/conky/wiki/configs/ke49/screenshot-thumb.png)](https://raw.github.com/wiki/brndnmtthws/conky/configs/ke49/screenshot.png)
@ -38,37 +38,44 @@ bars and graph widgets, with different fonts and colours.
See the User Configs below for more screenshots and associated config files.
### Documentation
## Documentation
The [GitHub Wiki](https://github.com/brndnmtthws/conky/wiki) serves as a central hub for all of
Conky's documentation.
* [Installation](https://github.com/brndnmtthws/conky/wiki/Installation)
* [Configuration Settings](https://github.com/brndnmtthws/conky/wiki/Configurations)
* [User Configs](https://github.com/brndnmtthws/conky/wiki/Configs)
* [Frequently Asked Questions](https://github.com/brndnmtthws/conky/wiki/FAQ)
- [Installation](https://github.com/brndnmtthws/conky/wiki/Installation)
- [Configuration Settings](https://github.com/brndnmtthws/conky/wiki/Configurations)
- [User Configs](https://github.com/brndnmtthws/conky/wiki/Configs)
- [Frequently Asked Questions](https://github.com/brndnmtthws/conky/wiki/FAQ)
### License
## License
Conky is licensed under the terms of the [GPLv3](LICENSE) license.
### Contributing
## Contributing
Contributions are welcome from anyone.
To report bugs or issues, open [new issues](https://github.com/brndnmtthws/conky/issues/new).
To submit code changes, open [new pull requests](https://github.com/brndnmtthws/conky/compare).
Patches submitted in issues, email, or elsewhere will likely be ignored. When submitting PRs, please:
Patches submitted in issues, email, or elsewhere may be ignored. When submitting PRs, please:
* Describe the changes, why they were necessary, etc
* Describe how the changes affect existing behaviour
* Describe how you tested and validated your changes
* Include any relevant screenshots/evidence demonstrating that the changes work and have been tested
* Any new source files should include a GPLv3 license header
* Any contributed code must be GPLv3 licensed
- Describe the changes, why they were necessary, etc
- Describe how the changes affect existing behaviour
- Describe how you tested and validated your changes
- Include unit tests when appropriate
- Include any relevant screenshots/evidence demonstrating that the changes work and have been tested
- Any new source files should include a GPLv3 license header
- Any contributed code must be GPLv3 licensed
- Always leave the code better than you found it
- PRs with failed checks may be ignored or closed; please make sure
the build and checks pass if possible (and notify someone when the build
system is not working)
[MPD]: https://musicpd.org/
[XMMS2]: https://github.com/xmms2/wiki/wiki
[Audacious]: https://audacious-media-player.org/
[mpd]: https://musicpd.org/
[xmms2]: https://github.com/xmms2/wiki/wiki
[audacious]: https://audacious-media-player.org/
[luawiki]: https://en.wikipedia.org/wiki/Lua_%28programming_language%29
[Imlib2]: https://docs.enlightenment.org/api/imlib2/html/
[imlib2]: https://docs.enlightenment.org/api/imlib2/html/
[cairo]: https://www.cairographics.org/