Merge pull request 'Docs(readme): content for README' (#14) from docs/readme into main

Reviewed-on: #14 Reviewed-by: Jakob Gregory
2026-08-01 13:47:24 +02:00
parent 9adc98a795 1e21e1889f
commit b93c515f55
1 changed files with 18 additions and 2 deletions
@@ -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