docs: add documentation to the repo and improve layout
This commit is contained in:
13
README.md
13
README.md
@@ -4,7 +4,7 @@
|
||||
[](https://liberapay.com/timokoesters)
|
||||
[](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?
|
||||
|
||||
|
||||
Reference in New Issue
Block a user