Add documentation.

This commit is contained in:
2020-06-01 02:52:40 +01:00
parent dc824dc519
commit 448c836d4d
3 changed files with 25 additions and 0 deletions

View File

@@ -5,3 +5,12 @@ Welcome to the Marechai repository.
This repository contains the Marechai software.
For contributing please read [here.](CONTRIBUTING.md)
For development you need:
* A .NET Core 3.1 compatible development environment.
* .NET Core 3.1 SDK
* ASP.NET Core 3.1 runtime
* ImageMagick, including HEIF and WebP support in the path.
* AV1F, specially, avifenc, in the path.
* MariaDB or compatible, with a user and a database.
* Prepare appsettings.json with a connection string for said database.