1 files changed, 68 insertions, 0 deletions
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..5efd598
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,68 @@
+
+
+-----
+LimoX
+-----
+
+The Linux on mobile XMPP (LimoX) client. It should be fast, compliant and
+usable on mobile linux devices like smartphones or tablets.
+
+
+Roadmap
+-------
+
+- [x] build a GTK 4 GUI
+- [ ] finish minimal viable product (MVP) to send and receive text messages
+	- [x] static GUI widgets
+	- [x] dynamic GUI widgets (like text messages)
+	- [ ] roster request
+	- [ ] receiving one-to-one text messages
+	- [ ] sending one-to-one text messages
+- [ ] persistence with sqlite3
+- [ ] refactoring
+- [ ] XMPP core compliance suite 2022 / client [1]
+	- [ ] RFC 6120: XMPP Core
+	- [ ] RFC 7590: TLS for XMPP
+	- [ ] XEP-0030: Service Discovery
+	- [ ] XEP-0115: Entity Capabilities
+- [ ] XMPP IM compliance suite 2022 / client [1]
+	- [ ] RFC 6121: XMPP Instant Messaging
+	- [ ] XEP-0245: The /me Command
+	- [ ] XEP-0054: vcard-temp
+	- [ ] XEP-0280: Message Carbons
+	- [ ] XEP-0045: Multi-User Chat
+	- [ ] XEP-0249: Direct MUC Invitations
+	- [ ] XEP-0363: HTTP File Upload
+- [ ] XMPP mobile compliance suite 2022 / client [1]
+	- [ ] XEP-0198: Stream Management
+	- [ ] XEP-0352: Client State Indication
+- [ ] implement further XEPs
+	- [ ] XEP-0077: In-Band Registration (just password change)
+	- [ ] XEP-0313: Message Archive Management
+	- [ ] XEP-0333: Chat Markers
+	- [ ] XEP-0085: Chat State Notifications
+	- [ ] XEP-0191: Blocking Command
+	- [ ] XEP-0308: Last Message Correction
+	- [ ] XEP-0393: Message Styling
+	- [ ] XEP-0444: Message Reactions
+	- [ ] XEP-0392: Consistent Color Generation
+	- [ ] XEP-0286: Mobile Considerations on LTE Networks
+	- [ ] XEP-0184: Message Delivery Receipts
+	- [ ] XEP-0380: Explicit Message Encryption
+	- [ ] XEP-0384: OMEMO Encryption
+
+
+Building
+--------
+
+Just run these commands to build and run:
+
+	meson build
+	ninja -C build
+	./build/limox
+
+Run `rm -r build` to clean the build folder. You can get a help page by running
+`./build/limox -h`.
+
+
+[1] https://xmpp.org/extensions/xep-0459.html