summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2023-01-08 18:54:54 +0100
committerxengineering <me@xengineering.eu>2023-01-08 19:04:26 +0100
commit82df83c7169e28f5808a99f27735049c03b1980a (patch)
treef96d4dc1164494dc9f71125d27c65de7f88204cc
parent2602ba91fb804224aeece0c9abf1abcbc2345403 (diff)
downloadlimox-82df83c7169e28f5808a99f27735049c03b1980a.tar
limox-82df83c7169e28f5808a99f27735049c03b1980a.tar.zst
limox-82df83c7169e28f5808a99f27735049c03b1980a.zip
Split README and ROADMAP
Roadmap content should not spam the README
-rw-r--r--README.md56
-rw-r--r--ROADMAP.md39
2 files changed, 49 insertions, 46 deletions
diff --git a/README.md b/README.md
index 3dd9381..33aab18 100644
--- a/README.md
+++ b/README.md
@@ -5,10 +5,10 @@
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][2] and my [packaging repository][3] for Arch Linux
-with support for LimoX. A nice reference which helps me a lot is [Beej's Guide
-to Network Programming][4] aswell as [Gigi's SDL2 tutorial][6] and the [SDL2
-documentation][5].
+Also mind the `ROADMAP` file, the [project page][1] and my [packaging
+repository][2] for Arch Linux with support for LimoX. A nice reference which
+helps me a lot is [Beej's Guide to Network Programming][3] aswell as [Gigi's
+SDL2 tutorial][5] and the [SDL2 documentation][4].
## Building and dependencies
@@ -23,7 +23,7 @@ Install these runtime dependencies:
- sdl2
-Just run these commands to build and run:
+Just run these commands to build, test and run:
```
make all
@@ -34,44 +34,8 @@ Run `make clean` to clean the build folder. You can get a help page by running
`./build/limox -h`.
-## Roadmap
-
-- [x] develop minimal viable product with GTK4 (branch `legacy/gtk4-libstrophe`)
-- [ ] implement XMPP core client ([compliance suite 2022][1])
- - [ ] RFC 6120: XMPP Core
- - [ ] RFC 7590: TLS for XMPP
- - [ ] XEP-0030: Service Discovery
- - [ ] XEP-0115: Entity Capabilities
-- [ ] implement XMPP mobile client ([compliance suite 2022][1])
- - [ ] XEP-0198: Stream Management
- - [ ] XEP-0352: Client State Indication
-- [ ] implement XMPP IM client ([compliance suite 2022][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
-- [ ] implement further XEPs
- - [ ] XEP-0077: In-Band Registration (just password change)
- - [ ] XEP-0313: Message Archive Management
- - [ ] XEP-0286: Mobile Considerations on LTE Networks
- - [ ] 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-0184: Message Delivery Receipts
- - [ ] XEP-0380: Explicit Message Encryption
- - [ ] XEP-0384: OMEMO Encryption
-
-
-[1]: https://xmpp.org/extensions/xep-0459.html
-[2]: https://xengineering.eu/git/limox
-[3]: https://xengineering.eu/git/pkgbuilds
-[4]: https://www.beej.us/guide/bgnet/html/
-[5]: https://wiki.libsdl.org/SDL2/FrontPage
-[6]: https://gigi.nullneuron.net/gigilabs/writing/sdl2-tutorials/
+[1]: https://xengineering.eu/git/limox
+[2]: https://xengineering.eu/git/pkgbuilds
+[3]: https://www.beej.us/guide/bgnet/html/
+[4]: https://wiki.libsdl.org/SDL2/FrontPage
+[5]: https://gigi.nullneuron.net/gigilabs/writing/sdl2-tutorials/
diff --git a/ROADMAP.md b/ROADMAP.md
new file mode 100644
index 0000000..d26aab2
--- /dev/null
+++ b/ROADMAP.md
@@ -0,0 +1,39 @@
+
+
+# Roadmap
+
+- [x] develop minimal viable product with GTK4 (branch `legacy/gtk4-libstrophe`)
+- [ ] develop minimal viable product with SDL2
+- [ ] implement XMPP core client ([compliance suite 2022][1])
+ - [ ] RFC 6120: XMPP Core
+ - [ ] RFC 7590: TLS for XMPP
+ - [ ] XEP-0030: Service Discovery
+ - [ ] XEP-0115: Entity Capabilities
+- [ ] implement XMPP mobile client ([compliance suite 2022][1])
+ - [ ] XEP-0198: Stream Management
+ - [ ] XEP-0352: Client State Indication
+- [ ] implement XMPP IM client ([compliance suite 2022][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
+- [ ] implement further XEPs
+ - [ ] XEP-0077: In-Band Registration (just password change)
+ - [ ] XEP-0313: Message Archive Management
+ - [ ] XEP-0286: Mobile Considerations on LTE Networks
+ - [ ] 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-0184: Message Delivery Receipts
+ - [ ] XEP-0380: Explicit Message Encryption
+ - [ ] XEP-0384: OMEMO Encryption
+
+
+[1]: https://xmpp.org/extensions/xep-0459.html