Nexus/nexus
Nexus/nexus
3
2
Fork 4
Code Issues 10 Pull requests Projects Releases Packages Wiki Activity

Add development instructions

Browse source
This commit is contained in:
Henry Hiles 2026-05-09 18:23:41 -04:00
commit 00c3503c1f
Signed by: Henry-Hiles
SSH key fingerprint: SHA256:VKQUdS31Q90KvX7EkKMHMBpUspcmItAh86a+v7PGiIs
2 changed files with 15 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

11
DEVELOPMENT.md Normal file
View file

@ -0,0 +1,11 @@
## Build instructions
CBuild instructions can be found in [README.md](./README.md#build-it-yourself).
## Updating Gomuks
You can run the following command to update the Gomuks submodule:
```sh
git submodule update --remote
```

5
README.md
View file

@ -53,7 +53,7 @@ A simple and user-friendly Matrix client made with Flutter and a Gomuks backend.
- [x] HTML/Markdown - [x] HTML/Markdown
- [x] Replies - [x] Replies
- [x] Choose ping on/off - [x] Choose ping on/off
- [ ] Per message profiles - [x] Per message profiles
- [ ] Attachments - [ ] Attachments
- [ ] Commands with [MSC4391](https://github.com/matrix-org/matrix-spec-proposals/pull/4391) - [ ] Commands with [MSC4391](https://github.com/matrix-org/matrix-spec-proposals/pull/4391)
- [x] Mentions - [x] Mentions
@ -120,6 +120,7 @@ A simple and user-friendly Matrix client made with Flutter and a Gomuks backend.
- [ ] Align your message bubbles to left or right - [ ] Align your message bubbles to left or right
- [ ] Show media by default - [ ] Show media by default
- [ ] Dynamic Theming - [ ] Dynamic Theming
- [ ] Setting per-message profiles for users (MSC4461)
- [ ] Devices - [ ] Devices
- [ ] Viewing devices - [ ] Viewing devices
- [ ] Verifying devices - [ ] Verifying devices
@ -218,6 +219,8 @@ Run the app:
flutter run flutter run
``` ```
Development instructions can be found in [DEVELOPMENT.md](./DEVELOPMENT.md).
## Community ## Community
Join the [Nexus Client Matrix Room](https://matrix.to/#/#nexus:federated.nexus) for questions or help with developing or using Nexus Client. Join the [Nexus Client Matrix Room](https://matrix.to/#/#nexus:federated.nexus) for questions or help with developing or using Nexus Client.