Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-11-17 02:25:09 +00:00
Code Issues Releases Activity

README.md: fix broken/non-secure links, update content (#586)

Browse Source
This commit is contained in:
lasers 2018-08-07 14:58:41 -05:00 committed by GitHub
parent 0b71e49723
commit f54ea8fac0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -1,4 +1,4 @@
## Conky # Conky
[![Build Status](https://travis-ci.org/brndnmtthws/conky.png)](https://travis-ci.org/brndnmtthws/conky) [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=conky&metric=alert_status)](https://sonarcloud.io/dashboard/index/conky) [![Build Status](https://travis-ci.org/brndnmtthws/conky.png)](https://travis-ci.org/brndnmtthws/conky) [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=conky&metric=alert_status)](https://sonarcloud.io/dashboard/index/conky)
@ -18,9 +18,9 @@ Conky can display more than 300 built-in objects, including support for:
* Built-in support for many popular music players ([MPD][], * Built-in support for many popular music players ([MPD][],
[XMMS2][], [BMPx][], [Audacious][]). [XMMS2][], [BMPx][], [Audacious][]).
* Can be extended using built-in [**Lua**](lua) support, or any of your * Can be extended using built-in [**Lua**](lua) support, or any of your
own scripts and programs ([more](Lua Interface)). own scripts and programs ([more](https://github.com/brndnmtthws/conky/wiki#tutorial)).
* Built-in [**Imlib2**][Imlib2] and [**Cairo**][cairo] bindings for arbitrary drawing * Built-in [**Imlib2**][Imlib2] and [**Cairo**][cairo] bindings for arbitrary drawing
with Lua ([more](wiki/Lua-API)). with Lua ([more](https://github.com/brndnmtthws/conky/wiki/Lua-API)).
* Runs on Linux, FreeBSD, OpenBSD, DragonFlyBSD, NetBSD, Solaris, Haiku OS, and macOS! * Runs on Linux, FreeBSD, OpenBSD, DragonFlyBSD, NetBSD, Solaris, Haiku OS, and macOS!
... and much much more. ... and much much more.
@ -34,45 +34,41 @@ bars and graph widgets, with different fonts and colours.
[![screenshot](https://github.com/brndnmtthws/conky/wiki/configs/ke49/screenshot-thumb.png)](https://raw.github.com/wiki/brndnmtthws/conky/configs/ke49/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)
[![screenshot](https://github.com/brndnmtthws/conky/wiki/configs/jc/screenshot-thumb.png)](https://raw.github.com/wiki/brndnmtthws/conky/configs/jc/screenshot.png) [![screenshot](https://github.com/brndnmtthws/conky/wiki/configs/jc/screenshot-thumb.png)](https://raw.github.com/wiki/brndnmtthws/conky/configs/jc/screenshot.png)
See the [User Configs](https://github.com/brndnmtthws/conky/wiki/User-Configs) section of the wiki for more See the User Configs below for more screenshots and associated config files.
screenshots and their associated Conky config files.
### Documentation ### Documentation
The [GitHub Wiki](https://github.com/brndnmtthws/conky/wiki) serves as a central hub for all of The [GitHub Wiki](https://github.com/brndnmtthws/conky/wiki) serves as a central hub for all of
Conky's documentation. Quick links: Conky's documentation.
* [Install](https://github.com/brndnmtthws/conky/wiki/Installation) * [Installation](https://github.com/brndnmtthws/conky/wiki/Installation)
* [Configure](https://github.com/brndnmtthws/conky/wiki/Configuration-Settings) * [Configuration Settings](https://github.com/brndnmtthws/conky/wiki/Configuration-Settings)
* [User Configs](https://github.com/brndnmtthws/conky/wiki/User-Configs) * [User Configs](https://github.com/brndnmtthws/conky/wiki/User-Configs)
* [Frequently Asked Questions](https://github.com/brndnmtthws/conky/wiki/FAQ) * [Frequently Asked Questions](https://github.com/brndnmtthws/conky/wiki/FAQ)
### License ### License
Conky is licensed under the terms of the [GPLv3](LICENSE.GPL) and Conky is licensed under the terms of the [GPLv3](LICENSE) and
[BSD](LICENSE.BSD) licenses. [BSD](LICENSE.BSD) licenses.
### Contributing ### Contributing
To submit code changes, please open pull requests against [the GitHub repository](https://github.com/brndnmtthws/conky/edit/master/README.md). Patches submitted in issues, email, or elsewhere will likely be ignored. Here's some general guidelines when submitting PRs: 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).
* In your pull request, please: Patches submitted in issues, email, or elsewhere will likely be ignored. When submitting PRs, please:
* Describe the changes, why they were necessary, etc
* Describe how the changes affect existing behaviour * Describe the changes, why they were necessary, etc
* Describe how you tested and validated your changes * Describe how the changes affect existing behaviour
* Include any relevant screenshots/evidence demonstrating that the changes work and have been tested * 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 new source files should include a GPLv3 license header
* Any contributed code must be GPLv3 licensed * Any contributed code must be GPLv3 licensed
[MPD]: http://musicpd.org/ [MPD]: https://musicpd.org/
[XMMS2]: http://wiki.xmms2.xmms.se/index.php/Main_Page [XMMS2]: https://github.com/xmms2/wiki/wiki
[BMPx]: http://bmpx.backtrace.info/site/BMPx_Homepage [BMPx]: https://www.beep-media-player.org/
[Audacious]: http://audacious-media-player.org/ [Audacious]: https://audacious-media-player.org/
[luawiki]: http://en.wikipedia.org/wiki/Lua_%28programming_language%29 [luawiki]: https://en.wikipedia.org/wiki/Lua_%28programming_language%29
[stable-src]: https://github.com/brndnmtthws/conky/archive/1.9.0.tar.gz [Imlib2]: https://docs.enlightenment.org/api/imlib2/html/
[devel-src]: https://github.com/brndnmtthws/conky/archive/master.tar.gz [cairo]: https://www.cairographics.org/
[wiki]: https://github.com/brndnmtthws/conky/wiki
[lists]: http://sourceforge.net/mail/?group_id=143975
[ircconky]: irc://irc.freenode.net/conky
[Imlib2]: http://docs.enlightenment.org/api/imlib2/html/
[cairo]: http://www.cairographics.org/