---
title: "build_home"
---

[< Back to Reference](../reference.qmd) | [View source](https://usrbinr.codeberg.page/qrtdown//src/branch/main/R/build-home.R#L14)

# `build_home()`

Build Home Page

## Usage

```r
build_home(pkg = ".", quiet = FALSE)
```

## Arguments

| Argument | Description |
|----------|-------------|
| `pkg` | Path to package root |
| `quiet` | Suppress messages |

## Value

Invisibly returns the path to the created file

## Description

Generates index.qmd in the package root, which includes the user's
README.qmd (or README.md/README.Rmd) via Quarto's include directive.
This keeps the user's README untouched while adding qrtdown's sidebar metadata.
Build the package home page

