Skip to content

Commit

Permalink
docs: Move usage instructions from installation to getting started
Browse files Browse the repository at this point in the history
Signed-off-by: Sietze van Buuren <s.van.buuren@gmail.com>
  • Loading branch information
swvanbuuren committed Sep 1, 2024
1 parent 43bba6d commit 403961b
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 31 deletions.
37 changes: 35 additions & 2 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,39 @@ generating a Simple-CDD profile from a YAML recipe.
Install Simple-CDD-YAML according to the [installation
instructions](installation.md).

## Usage

Now that Simple-CDD-YAML is installed, the command `simple-cdd-yaml` should be
available. Make sure the appropriate environment (in which `simple-cdd-yaml` is
installed) has been activated prior to issuing this command. You can test it
out, by querying the help:

```bash
simple-cdd-yaml --help
```

This should result in the following output:

```console
usage: simple-cdd-yaml [-h] --recipe RECIPE [--profile PROFILE]
[--output OUTPUT] [--input INPUT] [--debos]
[--debos-output DEBOS_OUTPUT] [--vars key1=value1,key2=value2,...]

Generate simple-cdd profiles using YAML input

options:
-h, --help show this help message and exit
--recipe RECIPE set the config yaml file
--profile PROFILE profile name
--output OUTPUT profile output directory (default: .)
--input INPUT recipe/action working directory (default: .)
--debos if provided, try to generate a debos recipe instead
--debos-output DEBOS_OUTPUT
debos recipe output directory (default: ./debos)
--vars key1=value1,key2=value2,...
override root recipe variables
```

## Building a Simple-CDD profile

In order to build a profile from a given recipe file `<recipe-name>.yaml`,
Expand All @@ -18,8 +51,8 @@ simple-cdd-yaml --recipe recipe/<recipe-name>.yaml
```

Make sure the appropriate environment (in which `simple-cdd-yaml` is installed)
has been activated prior to issuing this command. Alternatively, you can prepend
the environment activation (here called `<simple-cdd-yaml-venv>`):
has been activated prior to issuing this command. Alternatively, you can
prepend the environment activation (here called `<simple-cdd-yaml-venv>`):

```bash
( . ~/.venv/<simple-cdd-yaml-venv>/bin/activate && \
Expand Down
31 changes: 2 additions & 29 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,32 +17,5 @@ pip install .

## Usage

Now that Simple-CDD-YAML is installed, the command `simple-cdd-yaml` should be
available in your virtual python environment. You can test it out, by querying
the help:

```bash
simple-cdd-yaml --help
```

This should result in the following output:

```console
usage: simple-cdd-yaml [-h] --recipe RECIPE [--profile PROFILE]
[--output OUTPUT] [--input INPUT] [--debos]
[--debos-output DEBOS_OUTPUT] [--vars key1=value1,key2=value2,...]

Generate simple-cdd profiles using YAML input

options:
-h, --help show this help message and exit
--recipe RECIPE set the config yaml file
--profile PROFILE profile name
--output OUTPUT profile output directory (default: .)
--input INPUT recipe/action working directory (default: .)
--debos if provided, try to generate a debos recipe instead
--debos-output DEBOS_OUTPUT
debos recipe output directory (default: ./debos)
--vars key1=value1,key2=value2,...
override root recipe variables
```
Refer to the [getting started](getting_started.md) to learn how to use
Simple-CDD-YAML.

0 comments on commit 403961b

Please sign in to comment.