The documentation in this repository is useful for developers who are working on the Embedded VM, or who want to use Embedded VM contentions in their projects.
Documentation includes:
- Developer Guide contains guidelines for developers working on the project
- C++ Guidelines contains guidelines for the C++ code used in the framework
- Documentation Guidelines clarify documentation practices for framework modules
- Error Model describes the framework's approach to error handling
- Namespaces.xlsx contains a list of namespaces defined by the framework
- Refactoring provides guidelines for cleaning up existing code
- The Patterns/ directory contains notes about patterns used throughout the framework
- The Reference/ directory contains useful references for developers.
- The Development Logs directory is used to archive notes and logs from past development efforts. These files may provide additional context for users who are wondering why specific decisions were made.