Update README to be more friendly for people first discovering the project

This commit is contained in:
Matthew Wild 2021-06-10 14:02:41 +01:00
parent e8dd2408b8
commit a6bd89e02a
1 changed files with 20 additions and 4 deletions

View File

@ -1,19 +1,35 @@
# Snikket builder
# Snikket server images
This is the source repository for building [Snikket service](https://snikket.org/service/)
Docker images.
## Requirements
Snikket is an open-source self-hosted personal messaging service. It aims to
provide an alternative to proprietary and centralized messaging platforms
while supporting all the expected features and being easy to use.
For more information see the [Snikket website](https://snikket.org/).
## Getting Started with Snikket
For instructions on getting started with Snikket, see the [Snikket installation
guide](https://snikket.org/service/quickstart/) on our website.
## Building images
This section is for people who want to build their own images of Snikket, e.g.
for development purposes.
### Requirements
- GNU make
- docker (tested on 19.03.5)
- ansible (tested on 2.7 (debian buster))
## Building
### Building
Run `make`
## Running
### Running
The easiest way is to use docker-compose. Copy the file `snikket.conf.example` to
`snikket.conf` and edit the values in it. Then run: