renamed 'home.md' to 'index.md' and updated readme

2025-06-04 21:02:00 +02:00
parent 87575ba69d
commit 2e17d76e0e
5 changed files with 16 additions and 8 deletions
--- a/README.md
+++ b/README.md
@ -1 +1,13 @@
 # RSE@PSI Website
+
+## Build Instructions
+
+1. Install the required dependencies:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+2. [Build the website](https://www.mkdocs.org/getting-started/):
+   ```bash
+   mkdocs serve
+    ```
--- a/docs/faq.md
+++ b/docs/faq.md
@ -1,5 +1 @@
 # FAQ
-
-<div class="video-wrapper">
-  <iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/NfDUkR3DOFw?si=MuoWNsIrBm_QjA5_" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
-</div>
--- a/docs/index.md
+++ b/docs/index.md
--- a/mkdocs.yaml
+++ b/mkdocs.yaml
@ -2,7 +2,7 @@
 site_name: RSE@PSI
 copyright: © Paul Scherrer Institute (PSI) | Content under CC0 License
 nav:
-  - Home: 'home.md'
+  - Home: 'index.md'
  - About: 'about.md'
  - FAQ: 'faq.md'
  - Blog: 'blog/index.md'