Skip to content

Commit c974975

Browse files
authored
Merge branch 'master' into documentation/V3.0.1_Update1
2 parents 852877d + e8f50cb commit c974975

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ comment.
2121

2222
Compatibility
2323
--------------
24-
Defintion: FAITHFULLY "All recorded data is correctly interpreted by the interface"
24+
Definition: FAITHFULLY "All recorded data is correctly interpreted by the interface"
2525

2626
Forward compatibility:
2727
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.
5656
Major:
5757
A change of the major version results in an incompatibility of code and recorded proto messages.
5858
- 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
6262
- Changing the technology
6363
ProtoBuffer -> FlatBuffer
6464

@@ -90,8 +90,9 @@ Detailed information about installation and usage of OSI can be found in the [Wi
9090

9191
In order to generate the doxygen documentation for OSI, please follow the following steps:
9292
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%`.
9596
4. From the cmd navigate to the build directory and run:
9697
```cmd
9798
cmake -DFILTER_PROTO2CPP_PY_PATH=<path-to-proto2cpp.py> <path-to-CMakeLists.txt>

0 commit comments

Comments
 (0)