Add required Python packages to README-template

.github/workflows/on-pr.yaml

@@ -26,11 +26,15 @@ jobs:
         with:
           ref: ${{ github.head_ref }}
 
-      - name: Check keys of the projects.yaml file
+      - name: Install Python packages
         run: |
           python3 -m venv .venv
           source .venv/bin/activate
-          pip3 install PyYAML 
+          pip3 install -r requirements.txt
+
+      - name: Check keys of the projects.yaml file
+        run: |
+          source .venv/bin/activate
           python3 check_keys.py >> summary.txt 
 
       - name: Post comment with summary 
@@ -49,9 +53,7 @@ jobs:
 
       - name: Generate HTML site and README.md
         run: |
-          python3 -m venv .venv
           source .venv/bin/activate
-          pip3 install lxml
           python3 init_site.py
           rm website/base.html
           python3 init_readme.py

.github/workflows/on-push.yaml

@@ -17,12 +17,15 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v3
 
-      - name: Generate HTML site and README.md
+      - name: Install Python packages
         run: |
           python3 -m venv .venv
           source .venv/bin/activate
-          pip3 install lxml
-          pip3 install PyYAML
+          pip3 install -r requirements.txt
+
+      - name: Generate HTML site and README.md
+        run: |
+          source .venv/bin/activate
           python3 check_keys.py
           python3 init_site.py
           python3 init_readme.py

README-template.md

@@ -2,9 +2,24 @@
 
 This repository contains scripts and data to generate HTML and markdown files presenting open source software projects of the [Faculty of Computer Science](https://cs.tu-dresden.de) at [TU Dresden](https://www.tu-dresden.de). The sources of information are `oss-projects.yaml`, which describes the projects, and `cs-groups.yaml`, which describes the research groups involved.
 
-Run `init_site.py` to generate a static HTML page with an overview of all projects.
+## How to use?
+
+Install the required packages (e.g. in venv):
+```bash
+pip3 install -r ./requirements.txt
+```
+
+Generate the README of this repository containing all projects:
+```bash
+python3 init_readme.py
+```
+
+Generate a static HTML page with an overview of all projects:
+```bash
+python3 init_site.py
+```
+The generated `index.html` as well as all the other files (CSS, Javascript, images) are in the `website/` folder.
 
-Run `init_readme.py` to generate the README of this repository containing all projects.
 
 ## Add a new project
 

requirements.txt

@@ -0,0 +1,2 @@
+PyYAML == 6.0.2
+lxml == 5.3.0