diff options
| author |   efiacor <fiachra.corcoran@est.tech> | 2022-10-25 11:46:34 +0100 |
|---|---|---|
| committer |   Michael Morris <michael.morris@est.tech> | 2022-10-27 14:16:14 +0000 |
| commit | 248a9f1c153333002df39567e33fd5fa6092a62b (patch) | |
| tree | 4ce527613327984d9c7cb13108ab11fde8cea3f9 /docs/sections/build.rst | |
| parent | cb2663200092725c96240548e8fa046575530703 (diff) | |
[SDC-DIST-CLIENT] Add new RTD entry
Update README etc
Signed-off-by: efiacor <fiachra.corcoran@est.tech>
Change-Id: I4f92684e82d3fc2df978af12100be0871b94178d
Issue-ID: DMAAP-1792
Diffstat (limited to 'docs/sections/build.rst')
| -rw-r--r-- | docs/sections/build.rst | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/sections/build.rst b/docs/sections/build.rst new file mode 100644 index 0000000..4ef3e71 --- /dev/null +++ b/docs/sections/build.rst @@ -0,0 +1,43 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2022 Nordix Foundation + +.. _build: + +Build +===== + +.. + * This section is used to describe how a software component is built from + source into something ready for use either in a run-time environment or to + build other components. + + * This section is typically provided for a platform-component, application, + and sdk; and referenced in developer guides. + + +Environment +----------- + +- JDK 11 + +- Maven 3.6.* + + - local .m2 settings.xml set to https://git.onap.org/oparent/plain/settings.xml + +For more information regarding Env set up see `Setting Up Your Development Environment`_. + +.. _Setting Up Your Development Environment: https://wiki.onap.org/display/DW/Setting+Up+Your+Development+Environment + + +.. _Build steps: + +Steps +----- + +Run the following from project root: + +``mvn clean install`` + +The result is JAR file under the ``sdc-distribution-client/target`` folder + |