aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Benjamin Staneck2018-04-10 22:14:17 +0200
committerGravatar GitHub2018-04-10 22:14:17 +0200
commit00935f13048caa58f5aa94d1a89b9dd67010fc29 (patch)
treee2439e0739b672fe23a05fe8d84390f3c8891b9d /README.md
parentPPA: fix script (diff)
downloadKVIrc-00935f13048caa58f5aa94d1a89b9dd67010fc29.tar.gz
KVIrc-00935f13048caa58f5aa94d1a89b9dd67010fc29.tar.bz2
KVIrc-00935f13048caa58f5aa94d1a89b9dd67010fc29.zip
Docs folder cleanup (#2366)
* delete accelerator.keys.txt content is at https://github.com/kvirc/KVIrc/wiki/Keyboard-shortcuts * delete INSTALL and doc/INSTALL.txt content is at https://github.com/kvirc/KVIrc/wiki/installation * delete doc/firefox.hack.txt should no longer be needed * delete doc/themes.howto.txt content is at https://github.com/kvirc/KVIrc/wiki/tutorials * delete doc/INSTALL-MacOS.txt content is at https://github.com/kvirc/KVIrc/wiki/Compiling-KVIrc-from-git-on-macOS-Sierra * add another VS file to .gitignore * delete doc/FAQ content is at https://github.com/kvirc/KVIrc/wiki/FAQ * delete old TODOs content should be, if relevant, in issues * delete doc/addon.howto.txt content is at https://github.com/kvirc/KVIrc/wiki/Addons * delete doc/scripting.faq.txt content is at https://github.com/kvirc/KVIrc/wiki/tutorials * delete translations.howto.txt and translations.spanish.notes.txt content should be at https://github.com/kvirc/KVIrc/wiki/Updating-KVIrc's-translations * delete win32_run_cmake.bat outdated? * adjust CMakeLists.txt for removed files * delete Windows compilation instructions content is at https://github.com/kvirc/KVIrc/wiki/Compiling-KVIrc-on-Windows * delete doc/hackers.guide.txt content is at https://github.com/kvirc/KVIrc/wiki/The-Source-Tree * delete doc/ui-style-tips.txt content is at https://github.com/kvirc/KVIrc/wiki/Contributing-code-to-KVIrc's-repositories * adjust README to doc changes * move main license file to root * adjust mentions of copyright files * revert status badges back from shields.io shields.io is overloaded all the time so the badges never display * change cmake syntax * restore the about license text to its original glory and install the amip license only on windows * update GPL2 from the GNU website * change the installer to show ABOUT-LICENSE as well
Diffstat (limited to 'README.md')
-rw-r--r--README.md58
1 files changed, 29 insertions, 29 deletions
diff --git a/README.md b/README.md
index 668a6d3c7..d3d3af3a5 100644
--- a/README.md
+++ b/README.md
@@ -1,47 +1,47 @@
-[![Travis Build Status](https://img.shields.io/travis/kvirc/KVIrc/master.svg?label=Linux%20%2F%20OS%20X)](https://travis-ci.org/kvirc/KVIrc)
-[![AppVeyor Build status](https://img.shields.io/appveyor/ci/DarthGandalf/KVIrc/master.svg?label=Windows)](https://ci.appveyor.com/project/DarthGandalf/kvirc/branch/master)
-[![Coverity Scan Build Status](https://img.shields.io/coverity/scan/6841.svg)](https://scan.coverity.com/projects/kvirc-coverity)
+# ![KVIrc-Midnight](https://github.com/kvirc/KVIrc/wiki/images/KVIrc-midnight.png) KVIrc
-![KVIrc-Midnight](https://github.com/kvirc/KVIrc/wiki/images/KVIrc-midnight.png)
-<!--![KVIrc logo](../master/data/icons/128x128/kvirc.png "KVIrc - The visual IRC client for the masses!") -->
+[![Travis Build Status](https://travis-ci.org/kvirc/KVIrc.svg?branch=master)](https://travis-ci.org/kvirc/KVIrc)
+[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/j6tjel0eaeyixcbn/branch/master?svg=true)](https://ci.appveyor.com/project/DarthGandalf/kvirc/branch/master)
+[![Coverity Scan Build Status](https://scan.coverity.com/projects/6841/badge.svg)](https://scan.coverity.com/projects/kvirc-coverity)
-## About
+<!--![KVIrc logo](../master/data/icons/128x128/kvirc.png "KVIrc - The visual IRC client for the masses!") -->
-Welcome, this is the GitHub development and bug tracker home for the KVIrc project.
+Welcome to the development and bug tracker for the KVIrc project.
-KVIrc is a free and portable IRC client leveraging the Qt GUI toolkit.
-KVIrc is written by Szymon Stefanek and the KVIrc development team, with the contribution and support of many IRC addicted developers around the world.
+KVIrc is a free and portable IRC client leveraging the Qt GUI toolkit.
+KVIrc is written by Szymon Stefanek and the KVIrc development team, with contributions and support of many IRC addicted developers around the world.
-### Getting involved
+## Getting Involved
-- [Contributing](https://github.com/kvirc/KVIrc/wiki/Getting-involved-and-contributing)
+* [Contributing](https://github.com/kvirc/KVIrc/wiki/Getting-involved-and-contributing)
-### Help & Support
+## Help & Support
-- [KVIrc - wiki - Homepage](https://github.com/kvirc/KVIrc/wiki/home)
-- [KVIrc manual](http://www.kvirc.net/doc)
-- [KVIrc API](http://www.kvirc.net/api)
-- [How to submit a bug report](https://github.com/kvirc/KVIrc/wiki/Submitting-a-bug-report)
-- [Open a bug report or make a suggestion](https://github.com/kvirc/KVIrc/issues)
-- Talk to us - [Join #KVIrc](https://webchat.freenode.net?nick=kvirc-user&channels=%23kvirc&prompt=1&uio=OT10cnVlde) on freenode.net
-- [KVIrc - Community forums](http://www.kvirc.ru/forum/)
+* [KVIrc Wiki](https://github.com/kvirc/KVIrc/wiki/home)
+* [KVIrc Manual](http://www.kvirc.net/doc)
+* [KVIrc API](http://www.kvirc.net/api)
+* [How to submit a bug report](https://github.com/kvirc/KVIrc/wiki/Submitting-a-bug-report)
+* [Open a bug report or make a suggestion](https://github.com/kvirc/KVIrc/issues)
+* Talk to us - [Join #KVIrc](https://webchat.freenode.net?nick=kvirc-user&channels=%23kvirc&prompt=1&uio=OT10cnVlde) on freenode.net
---
-Try one of our fresh off-the-press nightly development 32-bit or 64-bit builds for Windows, Ubuntu and Debian.
-### [Downloads](https://github.com/kvirc/KVIrc/wiki/Downloading-KVIrcs-nightly-source-or-binaries)
+
+## Downloads
+
+Try one of our fresh off-the-press [nightly builds for Windows, Ubuntu and Debian](https://github.com/kvirc/KVIrc/wiki/Downloading-KVIrcs-nightly-source-or-binaries).
We're also looking for volunteer packagers and maintainers to other Linux distributions, that can help us extend KVIrc's availability in other OS's.
-### Install and compile
+## Install and Compile
-Compiling KVIrc on your chosen platform is an alternative way to enjoy KVIrc, see below.
+If you want to compile KVIrc on your chosen platform, we have guides on how to do that for a few popuplar platforms:
-- [Linux install](https://github.com/kvirc/KVIrc/blob/master/doc/INSTALL.txt)
-- [macOS install](https://github.com/kvirc/KVIrc/blob/master/doc/INSTALL-MacOS.txt)
-- Windows [32-bit install](https://github.com/kvirc/KVIrc/blob/master/doc/INSTALL-Win32.txt) or [64-bit install](https://github.com/kvirc/KVIrc/blob/master/doc/INSTALL-Win64.txt)
+* [Linux](https://github.com/kvirc/KVIrc/wiki/installation)
+* [macOS](https://github.com/kvirc/KVIrc/wiki/Compiling-KVIrc-on-macOS)
+* [Windows](https://github.com/kvirc/KVIrc/wiki/Compiling-KVIrc-on-Windows)
-### Licensed under
+## License
-[![KVIrc GPLv2+](https://img.shields.io/badge/KVIrc-GPLv2+-blue.svg)](./doc/LICENSE-GPLV2)
+[![KVIrc GPLv2+](https://img.shields.io/badge/KVIrc-GPLv2+-blue.svg)](./COPYING)
[![OpenSSL](https://img.shields.io/badge/OpenSSL-Licence-orange.svg)](./doc/LICENSE-OPENSSL)
-[![OpenSSL exception](https://img.shields.io/badge/OpenSSL-Exception-orange.svg)](./doc/COPYING)
+[![OpenSSL exception](https://img.shields.io/badge/OpenSSL-Exception-orange.svg)](./doc/LICENSE-OPENSSL)