documentation

MLOS Documentation

This directory contains project wide documentation for things like coding standards, overall architecture descriptions, build instructions, etc.

Individual components may also include their own more detailed documentation within their subdirectories.

Note: Some documentation uses Mermaid for diagrams in addition to Markdown.
You can install Markdown Preview Enhanced for Atom or Visual Code to help render it more easily.

Getting Started

Here's a brief summary of some documentation suggestions to help get started:

1. See 01-Prerequisites.md for initial environment setup instructions.
2. See 02-Build.md for basic build instructions.
3. See 03-ExampleUsage.md for some usage examples for applying MLOS to some code/system.
4. See 04-Test.md for notes on testing those changes.
5. See 05-Debug.md for notes on debugging those changes.

Overview

Here's some documentation references describing the MLOS architecture:

1. MlosArchitecture.md
2. Glossary.md
3. DEEM 2020 Paper

Here's a document describing the layout of the repository:

• RepoOrganization.md

We also have a collection of Troubleshooting Tips started.

Contributing

See CONTRIBUTING.md for notes on making changes to MLOS itself.