From 0013cac77d48f72fa5e6656eaeb8cf87181e7db6 Mon Sep 17 00:00:00 2001
From: "Pietsch, Martin" <martin.pietsch@tu-dresden.de>
Date: Wed, 2 Oct 2019 14:44:10 +0200
Subject: [PATCH] added documentation
---
README.md | 77 ++++++++++++++++++++++++++++++++-----------------------
1 file changed, 45 insertions(+), 32 deletions(-)
diff --git a/README.md b/README.md
index 225dd44..a9aa1e8 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,51 @@
-Role Name
+Description
+===========
+
+This role provides base methods for each linux system role.
+
+Requirement
+===========
+
+Variables
+---------
+
+* linux_installer_home_mirror
+ * description:
+ * This option contains the URL of the home mirror servers of the installer files.
+ * The servers provides the basic images for an installer.
+ * default: http://tinycorelinux.net
+
+* linux_installer_local_mirror
+ * description:
+ * This option contains the URL of the local mirror servers of the installer files.
+ * The servers provides the basic images for an installer.
+ * default: {{ linux_installer_home_mirror }}
+
+* linux_build_installer_root
+ * description:
+ * This option contains the path to the temporary build path for a linux installer.
+ * This value is generated automatically.
+
+* linux_installer_version
+ * description:
+ * This options specifies the version of the installer.
+ * default: 10.x
+
+* linux_installer_distribution
+ * description:
+ * This option specifies the name of a linux distribution for the installer.
+ * default: ""
+
+Processes
=========
-A brief description of the role goes here.
-
-Requirements
-------------
-
-Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
-
-Role Variables
+buildinstaller
--------------
-A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
-
-Dependencies
-------------
-
-A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
-
-Example Playbook
-----------------
-
-Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
-
- - hosts: servers
- roles:
- - { role: username.rolename, x: 42 }
-
-License
--------
-
-BSD
+finaliseinstaller
+-----------------
-Author Information
-------------------
+Features
+========
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+This role provides to create a small linux installer image. It bases on Tiny Core Linux.
--
GitLab