add note about build dependencies

This commit is contained in:
blek 2023-10-09 20:55:26 +10:00
parent a2bc80d501
commit 7c525808a4
Signed by: blek
GPG Key ID: 14546221E3595D0C
1 changed files with 5 additions and 0 deletions

View File

@ -3,6 +3,11 @@ This is a part of blek! File that is responsible for serving and uploading files
This module is released under the GPLv3 with additions, copy of which is included in the top level of this repository.
## Building
First, install the build dependencies:
1. Rust toolchain
2. Git (latest version)
To get started with this, copy either `Dockerfile.dev` or `Dockerfile.prod` to `Dockerfile`, depending on your environment.
Then either build it manually or start it up using the `docker-compose.yml` file, which is provided in the top level directory.