Skip to content

Information for programmer in documation #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Contents:
:maxdepth: 2

user
programmer

.. _Yaml: http://yaml.org

Expand Down
40 changes: 40 additions & 0 deletions doc/programmer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@

================
Programmer Guide
================

As a programmer you are looking for source code.
You found it, here it is.

.. literalinclude:: ./cfgdemo/src/main.rs
:language: rust


Key link
========

The key link between configuration file
and the executable programm that you are writen
is the configuration ``struct``.

In the demo source code is struct named *Config*
and is *cfg* a variable.


config.yaml
===========

Nothing of ``Config`` or ``cfg`` needs to be in the YAML.
But the field names **must**.

Here the *.yaml* that goes with the above example source code.


.. literalinclude:: ./cfgdemo/config.yaml
:language: yaml


See also
========

The documentation of `serde <https://serde.rs/>`_.