diff options
author | Andrew Jeffery <andrew@aj.id.au> | 2019-01-16 23:33:15 +1030 |
---|---|---|
committer | Andrew Jeffery <andrew@aj.id.au> | 2019-01-16 23:40:27 +1030 |
commit | 27b854e995ea310baa53d57bc83a66dbe1c237a9 (patch) | |
tree | 966b0162eda08737958ccee980b4cd6df5067d52 | |
parent | 7d0b8686e98f606d20c0bf393bfe1dd8c3cd3388 (diff) | |
download | openbmc-docs-27b854e995ea310baa53d57bc83a66dbe1c237a9.tar.gz openbmc-docs-27b854e995ea310baa53d57bc83a66dbe1c237a9.zip |
meetings: Add code markdown where appropriate in README.md
Change-Id: I5183074d5d646d3022e2d713b19d77c7c72a2e2f
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
-rw-r--r-- | meetings/README.md | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/meetings/README.md b/meetings/README.md index e96dd29..0ddeaae 100644 --- a/meetings/README.md +++ b/meetings/README.md @@ -1,19 +1,22 @@ OPENBMC MEETINGS ================ -This takes the YAML formatted meetings.yaml file and converts to a .ics file -that can be used as input into a calendar. This process allows for adding + +This takes the YAML formatted `meetings.yaml` file and converts to a `.ics` +file that can be used as input into a calendar. This process allows for adding additional meetings in the future, just by adding another record to the yaml -file, as well as automating ical generation and email. The tool that is used -to do the conversion is yaml2ical. Follow the usage and installation +file, as well as automating ical generation and email. The tool that is used to +do the conversion is `yaml2ical`. Follow the usage and installation instructions here: https://github.com/openstack-infra/yaml2ical -Start by editing meetings.yaml, changing the fields to the needed values. You +Start by editing `meetings.yaml`, changing the fields to the needed values. You can get more description on the supported fields at the link above. -Once you are happy with the info in the yaml file, run the tool yaml2ical: +Once you are happy with the info in the yaml file, run the tool `yaml2ical`: -yaml2ical -f -y . -o meetings.ics +``` +$ yaml2ical -f -y . -o meetings.ics +``` -The -f parameter forces an overwrite of the existing ical file. +The `-f` parameter forces an overwrite of the existing ical file. |