nero/tsuki
1
0
Fork 0
Code Issues 2 Pull requests Projects Releases Packages Wiki Activity Actions

docs: add documentation to the repo and improve layout

Browse source
This commit is contained in:
Timo 2020-08-12 21:17:53 +02:00
parent 87ed132ae4
commit 2fc99c05e1
No known key found for this signature in database
GPG key ID: 24DA7517711A2BA4
3 changed files with 125 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -4,7 +4,7 @@
[![Liberapay](https://img.shields.io/liberapay/receives/timokoesters?logo=liberapay)](https://liberapay.com/timokoesters)
[![Matrix](https://img.shields.io/matrix/conduit:koesters.xyz?server_fqdn=matrix.koesters.xyz&logo=matrix)](https://matrix.to/#/#conduit:koesters.xyz)
#### What is the goal
#### What is the goal?
A fast Matrix homeserver that's easy to set up and just works. You can install it on a mini-computer like the Raspberry Pi to host Matrix for your family, friends or company.
@ -18,11 +18,14 @@ Yes! Just open a Matrix client (<https://app.element.io> or Element Android for
#### How can I deploy my own?
You just have to clone the repo, build it with `cargo build --release` and call the binary (target/release/conduit) from somewhere like a systemd script.
It's explained in more detail [here](https://git.koesters.xyz/timo/conduit/wiki/Deploy).
##### From source
Or you can just build the docker image and run it with docker or docker-compose.
It's explained in more details [here](https://git.koesters.xyz/timo/conduit/wiki/Docker) or in the [README](docker/README.md) in the docker folder.
Clone the repo, build it with `cargo build --release` and call the binary
(target/release/conduit) from somewhere like a systemd script. [Read more](DEPLOY_FROM_SOURCE.md)
##### Using Docker
Build the docker image and run it with docker or docker-compose. [Read more](docker/README.md)
#### What is it build on?