Skip to content

Commit 6faf299

Browse files
author
mcorino
authored
Merge pull request #63 from mcorino/mco-prepare-210-release
Adding some release instructions
2 parents 29fcf75 + 0730b5c commit 6faf299

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.adoc

+10-5
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This can be done all together by executing the following commands
4545

4646
For all commands additional help is available by executing `bin/brix11 help _command_`.
4747

48-
== Bootstrap
48+
=== Bootstrap
4949

5050
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
5151

@@ -55,7 +55,7 @@ TAOX11 can be specified as optional target, which is done using
5555

5656
bin/brix11 bootstrap taox11
5757

58-
== Configure
58+
=== Configure
5959

6060
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
6161

@@ -69,23 +69,28 @@ for example `-W nddshome=$HOME/NDDS/rti_connext_dds-5.2.3 -W nddsarch=x64Linux3g
6969
RTI Connext DDS home and architecture. This will cause the settings to be stored in the BRIX11 configuration.
7070
The `bin/brix11 env` command will show you all environment variables set up by BRIX11.
7171

72-
== Generate build artifacts
72+
=== Generate build artifacts
7373

7474
The generate step will generate the necessary build infrastructure using https://github.com/DOCGroup/MPC[MPC] to compile the core of the target.
7575

7676
bin/brix11 gen build workspace.mwc
7777

78-
== Compile
78+
=== Compile
7979

8080
The compile step will compile the core of the target with the default compiler for your platform
8181

8282
bin/brix11 make
8383

84-
== Generate user documentation
84+
=== Generate user documentation
8585

8686
User documentation can be generated after the `brix11 configure` command using https://asciidoctor.org/[Asciidoctor] by executing
8787

8888
bin/brix11 generate documentation
8989

9090
After generation the documentation can be found under `docs/html`. A good place to start reading is the `getting_started.html`
9191
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

Comments
 (0)