1 files changed, 61 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0196288
--- /dev/null
+++ b/README.md
@@ -0,0 +1,61 @@
+# `xxcc` is a XMPP Chat Client
+
+`xxcc` is a simple XMPP client written in C++, using the Qt5 framework,
+as well as a few other dependencies also based in Qt5. As opposed to
+other existing XMPP clients, `xxcc` is designed with touch-enabled
+devices and small screens in mind.
+
+**Note: `xxcc` is still considered early-stage software.**
+
+## Building
+
+`xxcc` can be built using the traditional procedure in CMake:
+
+```
+mkdir build
+cd build/
+cmake ..
+cmake --build .
+```
+
+### Dependencies
+
+- CMake `>= 3.13`
+- `pkg-config`
+- Qt5
+- [QXmpp](qxmpp/qxmpp) (imported as a `git` submodule)
+- [QtKeyChain](https://github.com/frankosterfeld/qtkeychain)
+- [QCA](https://userbase.kde.org/QCA)
+- [`libomemo-c`](https://github.com/dino/libomemo-c) (imported as a `git`
+submodule)
+
+##### Ubuntu / Debian
+
+```
+# apt install cmake qtkeychain-qt5-dev qttools5-dev-tools qtbase5-dev
+```
+
+## License
+
+Unless explicitly noted otherwise, `xxcc` is covered under the GNU General
+Public License v3 or later. Third-party libraries and software used by
+`xxcc` are covered by compatible licenses - read their project documentation
+for further reference.
+
+```
+xxcc, a XMPP Chat Client
+Copyright (C) 2023  Xavier Del Campo Romero
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+```