Skip to content

Commit 0357067

Browse files
committed
updates README.md
1 parent 6eb1974 commit 0357067

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

README.md

+21-5
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,44 @@ Easily accessible C++ object structure of [OpenDRIVE](http://opendrive.org/) aut
33

44
## Building
55
### Dependencies
6-
Make sure to meet these dependencies in advance:
7-
- [CodeSynthesis XSD](http://codesynthesis.com/products/xsd/) in conjunction with
6+
7+
- [CodeSynthesis XSD](http://codesynthesis.com/products/xsd/)
88
- [Xerces-C++](https://xerces.apache.org/xerces-c/)
99

1010
### Building on Unix
11-
With CMake as plattform-independent build tool **xodr** can be configured for various native build environments. An exemplary configuration for Make under Unix:
11+
12+
For an exemplary build on a fresh Ubuntu Linux 20.04 x64 (gcc 9.3.0) we first install the dependencies:
13+
14+
```
15+
sudo apt install xsdcxx
16+
sudo apt install libxerces-c-dev
17+
```
18+
19+
With CMake as plattform-independent build tool **xodr** can be configured for various native build environments. For our Ubuntu environment with Make:
20+
1221
```
1322
cd xodr
1423
mkdir build
1524
cd build
1625
cmake ..
1726
```
27+
1828
To build the project afterwards run
29+
1930
```
2031
make
2132
```
22-
If everything went fine you will find the resulting library in the `lib/` folder of the project root.
33+
34+
If everything went fine, you will find the resulting library in the `lib/` folder of the project root.
2335

2436
## Source Code Generation
25-
For convenience the underlying OpenDRIVE schema is provided in `schema/` but can be obtained from the [OpenDRIVE download section](http://opendrive.org/download.html) in recent and previous versions. The C++ class structure was generated with [CodeSynthesis XSD](http://codesynthesis.com/products/xsd/) and can be automatically re-generated using the XML data binding tool `xsd`. The code used in **xodr** was generated with `xsd` version 4.0.0 as follows:
37+
38+
For convenience the underlying OpenDRIVE schema is provided in `schema/` but can be obtained for free from [ASAM](https://www.asam.net/standards/detail/opendrive/) in recent and previous versions. The C++ class structure was generated with [CodeSynthesis XSD](http://codesynthesis.com/products/xsd/) and can be automatically re-generated using the XML data binding tool `xsd`. The code used in **xodr** was generated with `xsd` version 4.0.0 as follows:
39+
2640
```
2741
xsd cxx-tree --hxx-suffix .h --cxx-suffix .cpp --reserved-name access=parkingSpace_access --reserved-name link=lane_link schema/OpenDRIVE_1.4H.xsd
2842
```
43+
2944
## Licence
45+
3046
Due to XSD's [FLOSS Exception](http://www.codesynthesis.com/projects/xsd/FLOSSE) the generated code is includable in various Free/Libre and Open Source Software projects, see [XSD Licence](http://www.codesynthesis.com/products/xsd/license.xhtml).

0 commit comments

Comments
 (0)