From 5cc7b4f93b200eafc7a0344069a9718a625f1be5 Mon Sep 17 00:00:00 2001 From: bramjanssen Date: Tue, 7 May 2024 08:39:24 +0200 Subject: [PATCH] feat: added README file --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..773071d --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Welcome to the APEx documentation portal + +This GitHub repository manages the content of the APEx documentation portal. +The generation of the content is based on [Quarto](https://quarto.org/). +If you want to preview the content and your changes, it is important to install the Quarto CLI before edidt +Once this has been completed you can preview the content by running the following command: + +```bash +quarto preview . +``` + +# Welcome to the APEx documentation portal + +This GitHub repository serves as the central hub for managing the APEx documentation portal. +The content generation is facilitated by [Quarto](https://quarto.org/), an open-source scientific and technical publishing system. + +To preview the content and any changes you make, it's crucial to install the Quarto CLI beforehand. +Once installed, you can preview the content by running the following command in your terminal: + +```bash +quarto preview . +``` + +This command will initiate a local preview of the documentation portal, allowing you to review your changes before committing them. \ No newline at end of file