diff --git a/README.md b/README.md index fd0bf63..71911f0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,22 @@ -# repository-template +# frontend-assets -The template for repositories +The assets for the frontend of the search engine *Seekra* + +## Setup + +Please execute the setup script in `scripts/` for your platform when cloning the repository. + +## Project structure + +All assets are located in subfolders for their asset type in `src/`. Assets types are: + +- Fonts (`fonts`) +- Images (`images`) +- Videos (`videos`) +- Audio (`audio`) +- Icons (`icons`) + +There are also some special `src/` subfolders like those for legal content. ## Setup