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.adoc
+10-5
Original file line number
Diff line number
Diff line change
@@ -45,7 +45,7 @@ This can be done all together by executing the following commands
45
45
46
46
For all commands additional help is available by executing `bin/brix11 help _command_`.
47
47
48
-
== Bootstrap
48
+
=== Bootstrap
49
49
50
50
AXCIOMA is the default target for bootstrapping. The bootstrap command will clone all dependent git repositories to their expected location. This can be done by executing
51
51
@@ -55,7 +55,7 @@ TAOX11 can be specified as optional target, which is done using
55
55
56
56
bin/brix11 bootstrap taox11
57
57
58
-
== Configure
58
+
=== Configure
59
59
60
60
The configure step generates the necessary configuration files for the specified target (execute `bin/brix11 help configure` for more details). The configure step is performed by executing
61
61
@@ -69,23 +69,28 @@ for example `-W nddshome=$HOME/NDDS/rti_connext_dds-5.2.3 -W nddsarch=x64Linux3g
69
69
RTI Connext DDS home and architecture. This will cause the settings to be stored in the BRIX11 configuration.
70
70
The `bin/brix11 env` command will show you all environment variables set up by BRIX11.
71
71
72
-
== Generate build artifacts
72
+
=== Generate build artifacts
73
73
74
74
The generate step will generate the necessary build infrastructure using https://github.com/DOCGroup/MPC[MPC] to compile the core of the target.
75
75
76
76
bin/brix11 gen build workspace.mwc
77
77
78
-
== Compile
78
+
=== Compile
79
79
80
80
The compile step will compile the core of the target with the default compiler for your platform
81
81
82
82
bin/brix11 make
83
83
84
-
== Generate user documentation
84
+
=== Generate user documentation
85
85
86
86
User documentation can be generated after the `brix11 configure` command using https://asciidoctor.org/[Asciidoctor] by executing
87
87
88
88
bin/brix11 generate documentation
89
89
90
90
After generation the documentation can be found under `docs/html`. A good place to start reading is the `getting_started.html`
91
91
document (either under `docs/html/ciaox11` for AXCIOMA or `docs/html/taox11` for TAOX11).
92
+
93
+
== Building formal releases
94
+
95
+
To get and build a formal release either checkout a formal release tag after cloning this repository or download and install a formal release source package of this repository.
96
+
From there just follow the regular build steps outlined above. The bootstrap procedure will automatically pull in the right versions of the dependent git repositories.
0 commit comments