From 0dcbbff316cc50c980f007cce64eb8d577901593 Mon Sep 17 00:00:00 2001
From: Aditya Kela <a.kela@fz-juelich.de>
Date: Tue, 28 Nov 2023 22:44:40 +0100
Subject: [PATCH] added build steps, command section and a very brief overview
 of Astro in the readme file

---
 README.md | 78 +++++++++++++++++++++++++++++++------------------------
 1 file changed, 44 insertions(+), 34 deletions(-)

diff --git a/README.md b/README.md
index 1db3fb3..8431dc2 100644
--- a/README.md
+++ b/README.md
@@ -1,54 +1,64 @@
-# Astro Starter Kit: Basics
+# Project Website for Q(AI)²
+1. This repository is built on top of the
+[Astro Framework](https://astro.build/)
+2. ```Astro``` requires the ```npm``` ecosystem.
+You will need to install ```Node.js```. See here: https://nodejs.org
+3. After installing ```Node.js```, clone this repository and run the
+following command to install the dependencies:
+    ```sh
+    npm install
+    ```
+4. Next, run the following command to start the development server
+in your localhost environment.
+The server should start listening on port 4321 (if default).
+    ```sh
+    npm run dev
+    ```
+4. To build to static assets, please run:
+    ```sh
+    npm run build
+    ```
 
-```sh
-npm create astro@latest -- --template basics
-```
 
-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)
-[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics)
-[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json)
+## Commands
+
+All commands are run from the root of the project, from a terminal:
 
-> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+| Command                   | Action                                           |
+| :------------------------ | :----------------------------------------------- |
+| `npm install`             | Installs dependencies                            |
+| `npm run dev`             | Starts local dev server at `localhost:4321`      |
+| `npm run build`           | Build your production site to `./dist/`          |
+| `npm run preview`         | Preview your build locally, before deploying     |
+| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI                     |
 
-![just-the-basics](https://github.com/withastro/astro/assets/2244813/a0a5533c-a856-4198-8470-2d67b1d7c554)
 
-## 🚀 Project Structure
+## Project Structure
 
-Inside of your Astro project, you'll see the following folders and files:
+The project structure is the following.  
+Currently, there are no fonts populated in the ```fonts``` folder.  
+The PDFs folder holds the paper PDFs directly. If papers are linked instead, this folder can be deleted.  
+Right now, there is one PDF checked into the git repository as it makes it easy to verify across instances.
 
 ```text
 /
 ├── public/
-│   └── favicon.svg
 ├── src/
+│   ├── assets/
+│   │   └── fonts/
+│   │   └── images/
+│   │   └── PDFs
 │   ├── components/
 │   │   └── Card.astro
+│   │   └── Footer.astro
 │   ├── layouts/
 │   │   └── Layout.astro
 │   └── pages/
 │       └── index.astro
+│       └── impressum.astro
+│       └── datenschutz.astro
 └── package.json
 ```
 
-Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
-
-There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
-
-Any static assets, like images, can be placed in the `public/` directory.
-
-## 🧞 Commands
-
-All commands are run from the root of the project, from a terminal:
-
-| Command                   | Action                                           |
-| :------------------------ | :----------------------------------------------- |
-| `npm install`             | Installs dependencies                            |
-| `npm run dev`             | Starts local dev server at `localhost:4321`      |
-| `npm run build`           | Build your production site to `./dist/`          |
-| `npm run preview`         | Preview your build locally, before deploying     |
-| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |
-| `npm run astro -- --help` | Get help using the Astro CLI                     |
-
-## 👀 Want to learn more?
-
-Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
+Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
\ No newline at end of file