Skip to content

Commit

Permalink
more help about variables
Browse files Browse the repository at this point in the history
  • Loading branch information
aronatkins committed May 10, 2024
1 parent 846264b commit 88c2bd3
Showing 1 changed file with 24 additions and 6 deletions.
30 changes: 24 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,14 +65,32 @@ website:

Make the following modifications:

- **Copyright:** Copyright dates are represented as a range from the year of
first product release until now. Adapt the example for your product and
how that information is made available.

- **Product name:** Replace the `PRODUCT` placeholder with the product name.

- **Product version:** Adapt the version for your product based on how that
information is made available.
- **Product version:** Adapt the `PRODUCT_VERSION` variable for your product
based on how that information is made available. The example project gets
a default environment variable value from the
[`_environment`](https://quarto.org/docs/projects/environment.html) file.

You may need to dynamically define `PRODUCT_VERSION` before rendering your
documentation.

```bash
export PRODUCT_VERSION=$(cat version.txt)
```

- **Copyright:** Copyright dates are represented as a range from the year of
first product release until now. Adapt the `CURRENT_YEAR` variable for
your product and how that information is made available. The example
project gets a default environment variable value from the
[`_environment`](https://quarto.org/docs/projects/environment.html) file.

You may need to dynamically define `CURRENT_YEAR` before rendering your
documentation.

```bash
export CURRENT_YEAR=$(date "+%Y")
```

- **Images:** Copy the two images from the extension into your project.

Expand Down

0 comments on commit 88c2bd3

Please sign in to comment.