From 43b0ee171877bf94ad012c555846cc3c0f75f5c3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=9E=97=E5=8D=9A=E4=BB=81=28Buo-ren=20Lin=29?=
 <buo.ren.lin@gmail.com>
Date: Wed, 25 Sep 2024 18:13:40 +0800
Subject: [PATCH] docs(real-README): Implement README section templates
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: 林博仁(Buo-ren Lin) <buo.ren.lin@gmail.com>
---
 real.README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)

diff --git a/real.README.md b/real.README.md
index 45053b1..389c3e2 100644
--- a/real.README.md
+++ b/real.README.md
@@ -5,9 +5,50 @@ _project_summary_
 <https://gitlab.com/_namespace_/_project_>  
 [![The GitLab CI pipeline status badge of the project's `main` branch](https://gitlab.com/_namespace_/_project_/badges/main/pipeline.svg?ignore_skipped=true "Click here to check out the comprehensive status of the GitLab CI pipelines")](https://gitlab.com/_namespace_/_project_/-/pipelines) [![GitHub Actions workflow status badge](https://github.com/_namespace_/_project_/actions/workflows/check-potential-problems.yml/badge.svg "GitHub Actions workflow status")](https://github.com/_namespace_/_project_/actions/workflows/check-potential-problems.yml) [![pre-commit enabled badge](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white "This project uses pre-commit to check potential problems")](https://pre-commit.com/) [![REUSE Specification compliance badge](https://api.reuse.software/badge/gitlab.com/_namespace_/_project_ "This project complies to the REUSE specification to decrease software licensing costs")](https://api.reuse.software/info/gitlab.com/_namespace_/_project_)
 
+<!--
+## Requirements
+
+The following prerequisites must be met in order for the role to properly function:
+
+TBD
+
+## Dependencies
+
+The following Ansible resources needs to be installed in order for the role to properly function:
+
+TBD
+
+You can install them by running the following command in the role directory in a text terminal:
+
+```bash
+ansible-galaxy install -r requirements.yml
+```
+
+## Role Variables
+
+You can customize the role's behaviors by setting the following role variables:
+
+### _role name_
+
+#### Data type
+
+#### Default value
+
+#### Example value
+-->
+
+## Example playbooks
+
+Refer to the files under [the playbooks directory](playbooks/) for example playbooks.
+
+Note that you need to [create a self-referencing symbolic link](playbooks/roles/#creating-the-namespace-name-pseudo-role) for the playbooks to work if you want to run the playbooks directly in this role.
+
+
+<!--
 ## References
 
 To be addressed.
+-->
 
 ## Licensing