Skip to content

Commit d2a6c75

Browse files
committed
continued work on documentation
Signed-off-by: pasched <[email protected]>
1 parent 5eb9679 commit d2a6c75

File tree

5 files changed

+12
-26
lines changed

5 files changed

+12
-26
lines changed

general_docs/conventions.adoc

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
11
= Conventions
22

3-
== Naming Conventions
4-
5-
In this document, the following conventions apply:
6-
73
== Units
84

95
Every field has its own unit that is defined in the proto files.
10-
For more information, see <<_commenting_on_fields_and_enums, the example in the contribution guidelines.>>)
6+
For more information, see <<_commenting_on_fields_and_enums, the example in the contribution guidelines.>>
117

128
[#sec-273d9649-afab-45d3-b6c9-73c0e64971a0]
139
== Modal verbs

general_docs/deliverables.adoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
= Deliverables
2+
3+
The following deliverables are provided for {THIS_STANDARD}:
4+
5+
* User guide (overall scope, partly normative)
6+
* .proto files (normative)
7+
* Doxygen reference documentation (not normative)
8+
* OSMP packaging (OSMP packaging has its own version number, but is compatible with the version of {THIS_STANDARD}.)

general_docs/deliverables_and_standard

Lines changed: 0 additions & 16 deletions
This file was deleted.

general_docs/osi_repos.adoc

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,12 @@
33
{THIS_STANDARD} is an open-source standardization project.
44
OSI and its supporting tools are developed publicly on GitHub.
55

6-
The source code and documentation for OSI and OSI-related tools are spread over several repositories.
6+
The source code and documentation for OSI and OSI-related tools are spread over several repositories:
77

88
open-simulation-interface:: Main repository containing the interface description based on Google's Protocol Buffers, including helper scripts and test scripts.
99

1010
osi-documentation:: Source for the OSI user guide.
1111

1212
osi-sensor-model-packaging:: Packaging specification for OSI models used in FMI 2.0 cite:[fmi2.0] simulation environments, including examples.
1313

14-
osi-validation:: Source code and documentation for the OSI Validator, a CLI tool for validating OSI messages.
15-
16-
osi-visualizer:: Source code and documentation for the OSI Visualizer, a GUI tool for visualizing OSI messages.
17-
1814
proto2cpp:: Doxygen filter for creating the reference documentation from OSI .proto files.

index.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ include::./general_docs/foreword.adoc[leveloffset=+1]
4848

4949
== Introduction
5050

51+
include::./general_docs/deliverables.adoc[leveloffset=+2]
52+
5153
include::./general_docs/osi_repos.adoc[leveloffset=+2]
5254

5355
include::./general_docs/statements.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)