Hermes
/
Hermes
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add features to DESIGN.md

main
Erin Nova 2022-05-12 14:37:58 +00:00 committed by GitHub
parent d276910f0d
commit 5d77702711
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
DESIGN.md
View File

@ -1,5 +1,19 @@
# Design Docs
## Features
- Full modern protocol support
- Native Linux application
- Lightweight, fast, small footprint
- Easy to use & accesible
- Dark crystal profile backup
- Tor & proxy support
- Drafts & Bookmarks functionality
- Powerful filters & muting
- Basic social functionality (posts, reactions, profiles, CWs, private messages, pictures, etc.)
- Full markdown support (Discord-like)
- Well documented, easy to contribute to
- Welcoming & accepting community :3
## Frontend
Make sure to follow the [GNOME Human Interface Guidelines](https://developer.gnome.org/hig/).
@ -11,3 +25,4 @@ Make sure to follow the [GNOME Human Interface Guidelines](https://developer.gno
2. **Format:** Use `cargo fmt` before you commit in order to keep a consistent code style.
3. **Organize:** Keep similar functions in different files, similar files in folders, etc. Separate functions to allow reuse.
4. **Simplify:** Keep it as simple and easy to understand as possible. Don't introduce new dependencies unless necessary, and try to pick more lightweight options. It should be able to run fine on even low end machines.
5. **Conventions:** Use proper Linux & SSB conventions. Store configs in `~/.config`, data in `~/.local/share`, etc. *Don't* use `~/.ssb`, as [reccomended](https://www.manyver.se/faq/each-app-own-folder/) by Manyverse devs.