summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2022-10-06 20:34:32 +0200
committerxengineering <me@xengineering.eu>2022-10-06 20:34:32 +0200
commita9ac36fc0ca4281654cb982d1cf8832c5520b195 (patch)
tree41d3ad6af369c08eca5ca172a55449c87d6f57f7
parent30f3c5844539085d7716ef4ca93f4a88cc8de7be (diff)
downloadlimox-a9ac36fc0ca4281654cb982d1cf8832c5520b195.tar
limox-a9ac36fc0ca4281654cb982d1cf8832c5520b195.tar.zst
limox-a9ac36fc0ca4281654cb982d1cf8832c5520b195.zip
Switch to markdown based README
-rw-r--r--README.md (renamed from README.txt)25
1 files changed, 11 insertions, 14 deletions
diff --git a/README.txt b/README.md
index 3f0be82..d7751ed 100644
--- a/README.txt
+++ b/README.md
@@ -1,19 +1,15 @@
------
-LimoX
------
+# LimoX
The Linux on mobile XMPP (LimoX) client. It should be fast, compliant and
usable on mobile linux devices like smartphones or tablets.
-Also mind the project page (https://xengineering.eu/git/limox) and my packaging
-repository for Arch Linux with support for LimoX
-(https://xengineering.eu/git/pkgbuilds).
+Also mind the [project page][2] and my [packaging repository][3] for Arch Linux
+with support for LimoX.
-Building and dependencies
--------------------------
+## Building and dependencies
Install these build dependencies:
@@ -36,8 +32,7 @@ Run `rm -r build` to clean the build folder. You can get a help page by running
`./build/limox -h`.
-Roadmap
--------
+## Roadmap
- [x] build a GTK 4 GUI
- [x] finish minimal viable product (MVP) to send and receive text messages
@@ -59,12 +54,12 @@ Roadmap
- [ ] write docstrings
- [ ] check if code is splint-clean
- [ ] persistence with sqlite3
-- [ ] XMPP core compliance suite 2022 / client [1]
+- [ ] XMPP core [compliance suite 2022][1] / client
- [ ] RFC 6120: XMPP Core
- [ ] RFC 7590: TLS for XMPP
- [ ] XEP-0030: Service Discovery
- [ ] XEP-0115: Entity Capabilities
-- [ ] XMPP IM compliance suite 2022 / client [1]
+- [ ] XMPP IM [compliance suite 2022][1] / client
- [ ] RFC 6121: XMPP Instant Messaging
- [ ] XEP-0245: The /me Command
- [ ] XEP-0054: vcard-temp
@@ -72,7 +67,7 @@ Roadmap
- [ ] XEP-0045: Multi-User Chat
- [ ] XEP-0249: Direct MUC Invitations
- [ ] XEP-0363: HTTP File Upload
-- [ ] XMPP mobile compliance suite 2022 / client [1]
+- [ ] XMPP mobile [compliance suite 2022][1] / client
- [ ] XEP-0198: Stream Management
- [ ] XEP-0352: Client State Indication
- [ ] XEP-0077: In-Band Registration (just password change)
@@ -94,4 +89,6 @@ Roadmap
- [ ] XEP-0384: OMEMO Encryption
-[1] https://xmpp.org/extensions/xep-0459.html
+[1]: https://xmpp.org/extensions/xep-0459.html
+[2]: https://xengineering.eu/git/limox
+[3]: https://xengineering.eu/git/pkgbuilds