aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLinus Jahn (LNJ) <lnj@kaidan.im>2019-04-27 22:01:57 +0100
committerBoris Pek <tehnick-8@yandex.ru>2019-05-04 16:24:00 +0300
commit8cb3bb4a6d51ca26e0c75ea6ef3f9a3449c00f2b (patch)
tree2d89ffcf4fbc35d78e8be678d532f297c168728b
parent34a9bf3920e88994601305d2b5866bd6915a6b61 (diff)
downloadqxmpp-8cb3bb4a6d51ca26e0c75ea6ef3f9a3449c00f2b.tar.gz
README: Make headings not so offensive (caps lock)
I think this looks better.
-rw-r--r--README.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/README.md b/README.md
index 3d328104..12dce062 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
[![Build Status](https://img.shields.io/travis/qxmpp-project/qxmpp.svg)](https://travis-ci.org/qxmpp-project/qxmpp)
[![Code Coverage](https://img.shields.io/codecov/c/github/qxmpp-project/qxmpp.svg)](https://codecov.io/gh/qxmpp-project/qxmpp)
-ABOUT QXMPP
+About QXmpp
===========
QXmpp is a cross-platform C++ XMPP client and server library. It is written
@@ -21,7 +21,7 @@ libraries such as speex and theora enable additional features.
QXmpp is released under the terms of the GNU Lesser General Public License,
version 2.1 or later.
-BUILDING QXMPP
+Building QXmpp
==============
QXmpp requires Qt 5.0 or higher with SSL enabled.
@@ -45,7 +45,7 @@ You can pass the following arguments to CMake:
WITH_THEORA to enable theora video codec (default: false)
WITH_VPX to enable vpx video codec (default: false)
-INSTALLING QXMPP
+Installing QXmpp
================
After building QXmpp, you can install the Headers, Libraries
@@ -55,7 +55,7 @@ Install from command line:
cmake --build . --target install
-EXAMPLES
+Examples
========
Look at the example directory for various examples. Here is a description of
@@ -71,14 +71,14 @@ This is a very simple bot which echoes the message sent to it. Run this
example, send it a message from a friend of this bot and you will
receive the message back. This example shows how to receive and send messages.
-DOCUMENTATION
+Documentation
=============
You can find the API documentation for the latest QXmpp version here:
http://doc.qxmpp.org/
-SUPPORTED PLATFORMS
+Supported Platforms
===================
It should work on all the platforms supported by Qt. For a complete list of
@@ -86,7 +86,7 @@ platforms support by Qt, see:
https://doc.qt.io/qt-5/supported-platforms.html
-HOW TO REPORT A BUG
+How to report a bug
===================
If you think you have found a bug in QXmpp, we would like to hear about
@@ -95,7 +95,7 @@ is already know at:
https://github.com/qxmpp-project/qxmpp/issues
-DISCUSSION GROUP
+Discussion Group
================
Join QXmpp Discussion Group for queries, discussions and updates.