Zergling_man/moment
Zergling_man/moment
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

English-capsify *.md titles

Browse Source
This commit is contained in:
miruka 2020-03-19 19:42:49 -04:00
parent 9fd7aa3247
commit 2e07b1a84e
2 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
INSTALL.md
View File

@ -48,12 +48,12 @@ properties and double-click to launch.
[More detailed instructions](https://docs.appimage.org/introduction/quickstart.html#ref-quickstart) [More detailed instructions](https://docs.appimage.org/introduction/quickstart.html#ref-quickstart)
## Manual installation ## Manual Installation
Qt 5.12+, Python 3.6+ (with development headers and pip), Qt 5.12+, Python 3.6+ (with development headers and pip),
PyOtherSide 1.5+ and libolm 3+ are required. PyOtherSide 1.5+ and libolm 3+ are required.
### Environment variables ### Environment Variables
To ensure Qt **5** will be used by default, compile using all CPU cores and To ensure Qt **5** will be used by default, compile using all CPU cores and
optimize the build for your machine: optimize the build for your machine:
@ -64,7 +64,7 @@ export MAKEFLAGS="-j$(nproc)"
export CFLAGS="-march=native -O2 -pipe" export CFLAGS="-march=native -O2 -pipe"
``` ```
### Package manager dependencies ### Package Manager Dependencies
#### Alpine Linux 3.9+ / apk #### Alpine Linux 3.9+ / apk
@ -157,7 +157,7 @@ sudo xbps-install -Su qt5-devel qt5-declarative-devel \
libopenjpeg2-devel libmediainfo-devel libopenjpeg2-devel libmediainfo-devel
``` ```
### Installing PyOtherSide manually ### Installing PyOtherSide Manually
Skip this section if you already installed it from your Skip this section if you already installed it from your
distro's package manager. distro's package manager.
@ -171,7 +171,7 @@ make
sudo make install sudo make install
``` ```
### Installing libolm manually ### Installing libolm Manually
Skip this section if you already installed it from your Skip this section if you already installed it from your
distro's package manager. distro's package manager.
@ -207,7 +207,7 @@ if you have trouble installing it.
If everything went fine, run `mirage` to start. If everything went fine, run `mirage` to start.
## Common issues ## Common Issues
### cffi version mismatch ### cffi version mismatch

11
README.md
View File

@ -2,8 +2,8 @@
[Features](#currently-implemented-features) ⬥ [Features](#currently-implemented-features) ⬥
[Installation](INSTALL.MD) ⬥ [Installation](INSTALL.MD) ⬥
[Configuration & theming](#configuration-and-theming) ⬥ [Configuration & Theming](#configuration--theming) ⬥
[More screenshots](#more-screenshots) [Screenshots](#more-screenshots)
A fancy [matrix](https://matrix.org/) chat client for secure, A fancy [matrix](https://matrix.org/) chat client for secure,
decentralized communication with an emphasis on user experience decentralized communication with an emphasis on user experience
@ -11,7 +11,7 @@ and customization. **Currently in alpha**.
![Chat screenshot](extra/general/screenshots/01-chat.png?raw=true) ![Chat screenshot](extra/general/screenshots/01-chat.png?raw=true)
## Currently implemented features ## Currently Implemented Features
### Client ### Client
@ -53,7 +53,7 @@ and customization. **Currently in alpha**.
See [INSTALL.MD](INSTALL.MD). See [INSTALL.MD](INSTALL.MD).
## Configuration and theming ## Configuration & Theming
The config file can be found at *$XDG_CONFIG_HOME/mirage/settings.json*, The config file can be found at *$XDG_CONFIG_HOME/mirage/settings.json*,
or *~/.config/mirage/settings.json*. or *~/.config/mirage/settings.json*.
@ -111,11 +111,12 @@ restarting the app.
GUI settings will also be implemented in the future. GUI settings will also be implemented in the future.
## More screenshots ## Screenshots
![Sign-in](extra/general/screenshots/02-sign-in.png) ![Sign-in](extra/general/screenshots/02-sign-in.png)
![Account settings](extra/general/screenshots/03-account-settings.png) ![Account settings](extra/general/screenshots/03-account-settings.png)
![Room creation](extra/general/screenshots/04-create-room.png) ![Room creation](extra/general/screenshots/04-create-room.png)
![Chat](extra/general/screenshots/01-chat.png?raw=true)
![Main pane in small window](extra/general/screenshots/05-main-pane-small.png) ![Main pane in small window](extra/general/screenshots/05-main-pane-small.png)
![Chat in small window](extra/general/screenshots/06-chat-small.png) ![Chat in small window](extra/general/screenshots/06-chat-small.png)