github.com/awslabs/clencli@v0.0.0-20210514234156-7ecf17182a20/box/resources/init/clencli/readme.tmpl (about)

     1  <!--
     2  
     3    ** DO NOT EDIT THIS FILE
     4    ** 
     5    ** This file was automatically generated by the [CLENCLI](https://github.com/awslabs/clencli)
     6    ** 1) Make all changes directly to YAML files: clencli/<file>.yaml
     7    ** 2) Run `clencli render template --name=<file>` to render this file
     8    **
     9    ** By following this practice we ensure standard and high-quality accross multiple projects.
    10    ** DO NOT EDIT THIS FILE
    11  
    12  -->
    13  
    14  {{ if has (ds "db") "logo" }}
    15  ![{{ (ds "db").logo.label }}]({{ (ds "db").logo.url }})
    16  
    17  > {{ (ds "db").logo.label }}
    18  {{end}}
    19  
    20  {{ if has (ds "db") "shields" }}{{ range $badge := (ds "db").shields.badges }}{{ if ne $badge.image "" }}[![{{ $badge.description }}]({{$badge.image}})]({{$badge.url}}){{ else }}![{{ $badge.description }}]({{ $badge.url }}){{ end }}{{ end }}{{ end }}
    21  
    22  # {{ (ds "db").app.name }} {{ if has (ds "db").app "id" }} ( {{ (ds "db").app.id }} ) {{end}}
    23  
    24  {{ if has (ds "db").app "function" }}{{ (ds "db").app.function }}{{end}}
    25  
    26  ## Table of Contents
    27  ---
    28  
    29  
    30  {{ $db := ds "db" }}
    31  
    32  {{ if has (ds "db") "usage" }}{{ $usage := $db.usage }}{{ if ne $usage "" }} - [Usage](#usage) {{end}}{{end}}
    33  {{ if has (ds "db") "prerequisites" }}{{ $prerequisites := len $db.prerequisites }}{{ if gt $prerequisites 0 }} - [Prerequisites](#prerequisites) {{end}}{{end}}
    34  {{ if has (ds "db") "installing" }}{{ $installing := $db.installing }}{{ if ne $installing "" }} - [Installing](#installing) {{end}}{{end}}
    35  {{ if has (ds "db") "testing" }}{{ $testing := $db.testing }}{{ if ne $testing "" }} - [Testing](#testing) {{end}}{{end}}
    36  {{ if has (ds "db") "deployment" }}{{ $deployment := $db.deployment }}{{ if ne $deployment "" }} - [Deployment](#deployment) {{end}}{{end}}
    37  {{ if has (ds "db") "acknowledgments" }}{{ $acknowledgments := len $db.acknowledgments }}{{ if gt $acknowledgments 0  }} - [Acknowledgments](#acknowledgments) {{end}}{{end}}
    38  {{ if has (ds "db") "contributors" }}{{ $contributors := len $db.contributors }}{{ if gt $contributors 0 }} - [Contributors](#contributors) {{end}}{{end}}
    39  {{ if has (ds "db") "references" }}{{ $references := len $db.references }}{{ if gt $references 0 }} - [References](#references) {{end}}{{end}}
    40  {{ if has (ds "db") "license" }}{{ $license := $db.license }}{{ if ne $license "" }} - [License](#license) {{end}}{{end}}
    41  {{ if has (ds "db") "copyright" }}{{ $copyright := $db.copyright }}{{ if ne $copyright "" }} - [Copyright](#copyright) {{end}}{{end}}
    42  
    43  {{ if has (ds "db") "screenshots" }}
    44  ## Screenshots
    45  ---
    46  <details open>
    47    <summary>Expand</summary>
    48  
    49  {{ range $screenshot := (ds "db").screenshots }}
    50  | ![{{ $screenshot.label }}]({{ $screenshot.url }}) |
    51  |:--:| 
    52  | *{{ $screenshot.caption }}* |
    53  {{ end }}
    54  </details>
    55  {{ end }}
    56  
    57  {{ if has (ds "db") "usage" }}
    58  ## Usage
    59  ---
    60  <details open>
    61    <summary>Expand</summary>
    62  
    63  {{ (ds "db").usage }}
    64  </details>
    65  {{ end }}
    66  
    67  {{ if has (ds "db") "prerequisites" }}
    68  ## Prerequisites
    69  ---
    70  <details>
    71    <summary>Expand</summary>
    72  
    73  {{ range $prerequisite := (ds "db").prerequisites }}{{ printf "- [%s](%s) - %s\n" $prerequisite.name $prerequisite.url $prerequisite.description }}{{end}}
    74  </details>
    75  {{end}}
    76  
    77  {{ if has (ds "db") "installing" }}
    78  ## Installing
    79  ---
    80  <details open>
    81    <summary>Expand</summary>
    82  
    83  {{ (ds "db").installing }}
    84  </details>
    85  {{end}}
    86  
    87  {{ if has (ds "db") "testing" }}
    88  ## Testing
    89  ---
    90  <details>
    91    <summary>Expand</summary>
    92  
    93  {{ (ds "db").testing }}
    94  </details>
    95  {{end}}
    96  
    97  {{ if has (ds "db") "deployment" }}
    98  ## Deployment
    99  ---
   100  <details>
   101    <summary>Expand</summary>
   102  
   103  {{ (ds "db").deployment }}
   104  </details>
   105  {{end}}
   106  
   107  {{ if has (ds "db") "include" }}
   108  {{ range $file := (ds "db").include }}
   109  {{ defineDatasource $file $file }}
   110  {{ include $file }}{{end}}
   111  {{end}}
   112  
   113  {{ if has (ds "db") "contributors" }}
   114  ## Contributors
   115  ---
   116  <details open>
   117    <summary>Expand</summary>
   118  
   119  |     Name     |         Email        |       Role      |
   120  |:------------:|:--------------------:|:---------------:|
   121  {{ range $contributor := (ds "db").contributors }}{{ printf "|  %s  |  %s  |  %s  |\n" $contributor.name $contributor.email $contributor.role}}{{end}}
   122  </details>
   123  {{end}}
   124  
   125  {{ if has (ds "db") "acknowledgments" }}
   126  ## Acknowledgments
   127  ---
   128  <details>
   129    <summary>Expand</summary>
   130  
   131  Gratitude for assistance:
   132  {{ range $ack := (ds "db").acknowledgments }}{{ printf "  * %s - %s\n" $ack.name $ack.role }}{{end}}
   133  
   134  </details>
   135  {{end}}
   136  
   137  {{ if has (ds "db") "references" }}
   138  ## References
   139  ---
   140  <details open>
   141    <summary>Expand</summary>
   142  
   143  {{ range $ref := (ds "db").references }}{{ printf "  * [%s](%s) - %s\n" $ref.name $ref.url $ref.description }}{{end}}
   144  
   145  </details>
   146  {{end}}
   147  
   148  {{ if has (ds "db") "license" }}
   149  ## License
   150  ---
   151  {{ (ds "db").license}}{{ end }}
   152  {{ if (file.Exists "LICENSE") }}
   153  For more information please read [LICENSE](LICENSE).
   154  {{ end }}
   155  
   156  {{ if has (ds "db") "copyright" }}
   157  ## Copyright
   158  ---
   159  ```
   160  {{ (ds "db").copyright}}
   161  ```
   162  {{end}}