Update README

This commit is contained in:
SpiritCroc 2020-10-13 16:51:21 +02:00
parent ae9e45e558
commit 7391966cd7
2 changed files with 33 additions and 5 deletions

View File

@ -1,9 +1,37 @@
# SchildiChat-Desktop # SchildiChat-Desktop
Wrapper project for element-desktop, element-web, matrix-react-sdk and matrix-js-sdk, in order to build SchildiChat-Desktop. SchildiChat-Desktop is a fork of [Element-Web](https://github.com/vector-im/element-web)/[-Desktop](https://github.com/vector-im/element-desktop).
The most important changes of SchildiChat-Desktop compared to Element are:
- A unifed chat list for both direct and group chats
- Message bubbles
- Bigger items in the room list
While SchildiChat-Desktop should be already usable as is, it's still better seen as a
proof-of-concept rather than a finished product, as there are still a few UX bugs
remaining, and no ways to configure Schildi's features.
Furthermore, I don't know how much more work I'm going to put into this, but
if anybody wants to help improving it, contributions are welcome!
Downloads for Desktop: https://github.com/SpiritCroc/schildichat-desktop/releases <br/>
Hosted web variant: https://schildiweb.spiritcroc.de/
Feel free to [join the discussion on matrix](https://matrix.to/#/#schildichat-web:matrix.org).
<img src="https://raw.githubusercontent.com/SpiritCroc/schildichat-desktop/sc/screenshots/1.png"/>
# Debian compilation dependencies # Building SchildiChat-Desktop
This particular repo is a wrapper project for element-desktop, element-web, matrix-react-sdk and matrix-js-sdk, in order to build SchildiChat-Desktop.
## Debian compilation dependencies
Since Debian is usually slow to update packages on its stable releases, some dependencies
might not be recent enough to building Schildi.
Here are the dependencies which I had to install for compilation on Debian 10:
``` ```
# apt install vim curl git make gcc g++ libsqlcipher-dev pkg-config libsecret-1-dev bsdtar # apt install vim curl git make gcc g++ libsqlcipher-dev pkg-config libsecret-1-dev bsdtar
@ -21,7 +49,7 @@ $ echo 'export PATH="$PATH:$HOME/.cargo/bin"' >> .bashrc
$ source .bashrc $ source .bashrc
``` ```
# Initial setup ## Initial setup
``` ```
git clone --recurse-submodules https://github.com/SpiritCroc/schildichat-desktop.git git clone --recurse-submodules https://github.com/SpiritCroc/schildichat-desktop.git
@ -29,10 +57,10 @@ cd schildichat-desktop
./setup.sh ./setup.sh
``` ```
# Build ## Build
`make` `make`
# Install ## Install
Installable packages should appear in element-desktop/dist/. Installable packages should appear in element-desktop/dist/.

BIN
screenshots/1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 KiB