You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ comment.
21
21
22
22
Compatibility
23
23
--------------
24
-
Defintion: FAITHFULLY "All recorded data is correctly interpreted by the interface"
24
+
Definition: FAITHFULLY "All recorded data is correctly interpreted by the interface"
25
25
26
26
Forward compatibility:
27
27
Definition: "An older version of the code can be used to read new files"
@@ -56,9 +56,9 @@ The version number is defined in InterfaceVersion::version_number in osi_common.
56
56
Major:
57
57
A change of the major version results in an incompatibility of code and recorded proto messages.
58
58
- An existing field with a number changes its meaning
59
-
optional double field = 1; -> repeated double field = 1;
60
-
Changing the definition of units of a field
61
-
- Deleting a field and reusing the field number
59
+
```optional double field = 1;``` -> ```repeated double field = 1;```
60
+
Changing the definition of units or interpretation of a field
61
+
- Deleting a field and reusing the field number
62
62
- Changing the technology
63
63
ProtoBuffer -> FlatBuffer
64
64
@@ -90,8 +90,9 @@ Detailed information about installation and usage of OSI can be found in the [Wi
90
90
91
91
In order to generate the doxygen documentation for OSI, please follow the following steps:
92
92
1. Install [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html), set an environmental variable 'doxygen' with the path to the binary file and add it to the PATH variable: `PATH += %doxygen%`.
93
-
2. Download the [vg-1.5.0.zip](https://github.com/vgteam/vg/releases/tag/v1.5.0). Unpack and copy the content of folder /vg-1.5.0/contrib/proto2cpp to your desired `<path-to-proto2cpp.py>`
94
-
3. Install [graphviz-2.38](https://graphviz.gitlab.io/_pages/Download/Download_windows.html), set an environmental variable 'graphviz' with the path to the binary file and add it to the PATH variable: `PATH += %graphviz%`.
93
+
2. Download the [proto2cpp](https://github.com/OpenSimulationInterface/proto2cpp) repo.
94
+
Copy the content of the repo proto2cpp to your desired `<path-to-proto2cpp.py>`
95
+
3. Install [graphviz](https://graphviz.gitlab.io/_pages/Download/Download_windows.html), set an environmental variable 'graphviz' with the path to the binary file and add it to the PATH variable: `PATH += %graphviz%`.
95
96
4. From the cmd navigate to the build directory and run:
0 commit comments