diff --git a/README.md b/README.md index 2c1ff78046b5fa7dfca3f87c8303e69073a7cc26..222f03ae03459211e607fa04ea28a62ae819e106 100644 --- a/README.md +++ b/README.md @@ -9,15 +9,21 @@ full system on FVP. - Source Code is available at: [GitLab](https://gitlab.arm.com/tooling/shrinkwrap) - Shrinkwrap Container Images are available at: [DockerHub](https://hub.docker.com/u/shrinkwraptool) -To build the docs locally, the following packages need to be installed on the -host: +The documentation (linked above) contains a +[QuckStart](https://shrinkwrap.docs.arm.com/en/latest/userguide/quickstart.html) +section, which details how to install and use the tool. However, if you are in a +hurry, here are the minimal steps: - sudo apt-get install python3-pip - pip3 install -U -r documentation/requirements.txt +> **NOTE:** This assumes you have Python >=3.9.0 and docker installed. If this +> is not the case, please refer to the documentation. -To build and generate the documentation in html format, run: +``` + sudo apt-get install git netcat-openbsd python3 python3-pip telnet + sudo pip3 install pyyaml termcolor tuxmake + git clone https://git.gitlab.arm.com/tooling/shrinkwrap.git + export PATH=$PWD/shrinkwrap/shrinkwrap:$PATH +``` - sphinx-build -b html -a -W documentation public - -To render and explore the documentation, simply open `public/index.html` in a -web browser. +``` + shrinkwrap --help +``` diff --git a/documentation/developerguide/compiledocs.rst b/documentation/developerguide/compiledocs.rst new file mode 100644 index 0000000000000000000000000000000000000000..3f37879177dbed0e52386c448636f2bd0ff5a046 --- /dev/null +++ b/documentation/developerguide/compiledocs.rst @@ -0,0 +1,25 @@ +.. + # Copyright (c) 2023, Arm Limited. + # + # SPDX-License-Identifier: MIT + +############################# +Compile Documentation Locally +############################# + +To build the docs locally, the following packages need to be installed on the +host: + +.. code-block:: shell + + sudo apt-get install python3-pip + pip3 install -U -r documentation/requirements.txt + +To build and generate the documentation in html format, run: + +.. code-block:: shell + + sphinx-build -b html -a -W documentation public + +To render and explore the documentation, simply open `public/index.html` in a +web browser. diff --git a/documentation/developerguide/index.rst b/documentation/developerguide/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..52d730c5b7365d6f88a2428a6f426a4bd15d045e --- /dev/null +++ b/documentation/developerguide/index.rst @@ -0,0 +1,15 @@ +.. + # Copyright (c) 2023, Arm Limited. + # + # SPDX-License-Identifier: MIT + +############### +Developer Guide +############### + +.. toctree:: + :titlesonly: + :maxdepth: 2 + :caption: Contents + + compiledocs diff --git a/documentation/images/architecture.png b/documentation/images/architecture.png new file mode 100644 index 0000000000000000000000000000000000000000..a891b7af3e106209ded0218a99a4a92b08335b49 Binary files /dev/null and b/documentation/images/architecture.png differ diff --git a/documentation/index.rst b/documentation/index.rst index 8a7cd8b65a65e92cbde25f7f24d3cb47d5d86743..35f4018a07f1c9e86d3a074dfe09c06d8501600d 100644 --- a/documentation/index.rst +++ b/documentation/index.rst @@ -16,4 +16,5 @@ Contents overview userguide/index + developerguide/index license_file_link diff --git a/documentation/overview.rst b/documentation/overview.rst index fdc80ddcd1b2ccb1772fa4fb5b48fa13ace76fcd..487f05a9d449f367d05678fee655fa0a0c6cd5c7 100644 --- a/documentation/overview.rst +++ b/documentation/overview.rst @@ -1,5 +1,5 @@ .. - # Copyright (c) 2022, Arm Limited. + # Copyright (c) 2022,2023, Arm Limited. # # SPDX-License-Identifier: MIT @@ -63,6 +63,20 @@ runtime is specified by the user and may be ``null`` (executed natively on the user's system), or a container runtime such as ``docker`` or ``podman``. For the container runtimes, a standard image is provided with all tools preinstalled. +.. image:: images/architecture.png + +The command line interface has 2 main commands; build and run. The build command +takes a configuration (a yaml file) along with an optional overlay which tweaks +settings in the config, then builds and packages all the components described +within. The package could optionally be distributed for use by others. The run +command launches the built package on the FVP, allowing the user to interact +with it. The definition of how to run the FVP is contained in the original +config that was supplied at build time and is included in the package. The run +command allows further tweaking of this runtime config with another optional +overlay. The user can also optionally provide values for any runtime variables +(RTVARs) that are defined as part of the config. These are typically used to +point to the kernel or rootfs that should be used. + ******************** Repository Structure ********************