Skip to content

Commit ec0f920

Browse files
committed
added readme basics
1 parent a9e4951 commit ec0f920

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.yaml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
#
3+
# This is the canonical configuration for the `README.md`
4+
# Run `make readme` to rebuild the `README.md`
5+
#
6+
7+
# Name of this project
8+
name: ""
9+
10+
# Short description of this project
11+
description: |-
12+
Add here
13+
14+
# Canonical GitHub repo
15+
github_repo: osodevops/some-repo
16+
17+
# How to use this project
18+
usage: |-
19+
### Requirements
20+
None.
21+
22+
### Role Variables
23+
Some information
24+
```yaml
25+
---
26+
```
27+
28+
# Example usage
29+
examples: |-
30+
Follow this example
31+
```yaml
32+
---
33+
```
34+
35+
related:
36+
- name: ""
37+
description: ""
38+
url: "https://github.com/osodevops/"
39+
40+
# References
41+
references:
42+
- name: ""
43+
description: ""
44+
url: "https://"

0 commit comments

Comments
 (0)