Commit a5c5eb6c authored by Wohlgemuth, Jason's avatar Wohlgemuth, Jason
Browse files

docs: Add inception example

parent c5569daf

README.md

+2 −23
Original line number Diff line number Diff line
@@ -51,29 +51,8 @@ 
## Documentation

> **TIP** Read the code docs at https://xylem.code.ornl and/or explore the [Wiki](https://code.ornl.gov/research-enablement/xylem/-/wikis/home)



Print the help with `xylem help` or save the configuration below to `config.json` and use `xylem run`



```json

{

    "version": "0.0.1",

    "description": "Print Xylem help",

    "requirements": [],

    "modules": [

        {

            "name": "Meta Module",

            "type": "binary",

            "uri": "https://code.ornl.gov/api/v4/projects/15383/packages/generic/x86_64-unknown-linux-musl/v0.0.11/xylem",

            "checksum": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",

            "template": {

                "command": "xylem",

                "arguments": [

                    "help"

                ]

            }

        }

    ]

}

```

- See [xylem.ornl.gov](https://xylem.ornl.gov) to see generated code documentation

- See example configurations in the [`/examples`](./examples/) folder



### Architecture

> See [ARCHITECTURE.md](./ARCHITECTURE.md)

examples/inception/README.md

0 → 100644
+14 −0
Original line number Diff line number Diff line 
# Inception

> Run `xylem help` using Xylem v0.0.11



## Overview

- Download Xylem release

- Print Xylem version



## Running the Module

```shell

xylem run -vvvv

```



## Notes

- `-vvvv` is uses "trace" level logging which ensures you see the help output at the end of the run
 
 No newline at end of file

examples/inception/config.json

0 → 100644
+19 −0
Original line number Diff line number Diff line 
{

    "version": "0.0.1",

    "description": "Print Xylem help using Xylem",

    "requirements": [],

    "modules": [

        {

            "name": "Inception",

            "type": "binary",

            "uri": "https://code.ornl.gov/api/v4/projects/15383/packages/generic/x86_64-unknown-linux-musl/v0.0.11/xylem",

            "checksum": "31abbb18f09a9b1ef80bb7b75e60668eb1ef393ab46e399fffa4782a5e7cf5e4",

            "template": {

                "command": "xylem",

                "arguments": [

                    "help"

                ]

            }

        }

    ]

}
 
 No newline at end of file