diff --git a/README.md b/README.md index aaab6d6..1e3e23f 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,37 @@ # 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
+Hosted web variant: https://schildiweb.spiritcroc.de/ + +Feel free to [join the discussion on matrix](https://matrix.to/#/#schildichat-web:matrix.org). + + -# 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 @@ -21,7 +49,7 @@ $ echo 'export PATH="$PATH:$HOME/.cargo/bin"' >> .bashrc $ source .bashrc ``` -# Initial setup +## Initial setup ``` git clone --recurse-submodules https://github.com/SpiritCroc/schildichat-desktop.git @@ -29,10 +57,10 @@ cd schildichat-desktop ./setup.sh ``` -# Build +## Build `make` -# Install +## Install Installable packages should appear in element-desktop/dist/. diff --git a/screenshots/1.png b/screenshots/1.png new file mode 100644 index 0000000..d0f2ed0 Binary files /dev/null and b/screenshots/1.png differ