From adec62a93bbce65790654ae5cf409f94a43e19fd Mon Sep 17 00:00:00 2001 From: Rich Bennett Date: Wed, 21 Mar 2018 11:24:35 -0400 Subject: Add index and templates to music project Change-Id: Ie65fedc1ab8a01aba27fb328ec2f58bcb8e3b5f2 Signed-off-by: Rich Bennett Issue-ID: DOC-253 --- docs/configuration.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 docs/configuration.rst (limited to 'docs/configuration.rst') diff --git a/docs/configuration.rst b/docs/configuration.rst new file mode 100644 index 00000000..085f9c66 --- /dev/null +++ b/docs/configuration.rst @@ -0,0 +1,27 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Configuration +============= + +.. note:: + * This section is used to describe the options a software component offers for configuration. + + * Configuration is typically: provided for platform-component and sdk projects; + and referenced in developer and user guides. + + * This note must be removed after content has been added. + + + +Example ... + +You can provide the following in ``basic.conf`` + +``host=ADDRESS`` + The address of the host + +``port=PORT`` + The port used for signaling + + Optional. Default: ``8080`` -- cgit 1.2.3-korg