claunia/marechai
1
0
Fork 0
mirror of https://github.com/claunia/marechai.git synced 2025-12-16 02:54:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation.

Browse Source
This commit is contained in:
Natalia Portillo
2020-06-01 02:52:40 +01:00
parent dc824dc519
commit 448c836d4d
3 changed files with 25 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
Marechai/Marechai.csproj
View File

@@ -150,6 +150,18 @@
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
<CopyToPublishDirectory>PreserveNewest</CopyToPublishDirectory>
</Content>
<Content Include="..\CODEOWNERS">
<Link>CODEOWNERS</Link>
</Content>
<Content Include="..\CONTRIBUTING.md">
<Link>CONTRIBUTING.md</Link>
</Content>
<Content Include="..\README.md">
<Link>README.md</Link>
</Content>
<Content Include="..\TODO.md">
<Link>TODO.md</Link>
</Content>
</ItemGroup>
<ItemGroup>
<_ContentIncludedByDefault Remove="Areas\Admin\Views\BrowserTests\Delete.cshtml" />

9
README.md
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.

4
TODO.md Normal file
View File

@@ -0,0 +1,4 @@
## Known issues
* Blazor pages are calling the database twice because they are not using the proper initialization override.
* Company logos carrousel is not working.
* Company descriptions are not respecting localization.