From a1e75df7a0ef5454a70552836aeaf3f3bff7c70a Mon Sep 17 00:00:00 2001 From: Forest Eckhardt Date: Wed, 4 Dec 2024 21:12:51 +0000 Subject: [PATCH] Update README --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ced8143d..be84d6d8 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,14 @@ $ ./scripts/package.sh This builds the buildpack's source using GOOS=linux by default. You can supply another value as the first argument to package.sh. -## Specifying a project path +## Configuration -To specify a project subdirectory (i.e. the directory containing your -`.csproj`/`.fsproj`/`.vbproj` file), please use the BP_DOTNET_PROJECT_PATH -environment variable at build time either directly (e.g. pack build my-app ---env BP_DOTNET_PROJECT_PATH=./src/my-app) or through a project.toml file. This -configuration does not apply to FDD, FDE or Self-Contained app deployments. +### `BP_DOTNET_PROJECT_PATH` +To specify a project subdirectory to be used as the root of the app, please use +the `BP_DOTNET_PROJECT_PATH` environment variable at build time either directly +(e.g. `pack build my-app --env BP_DOTNET_PROJECT_PATH=./src/my-app`) or through a +[`project.toml` file](https://github.com/buildpacks/spec/blob/main/extensions/project-descriptor.md). + +```shell +BP_DOTNET_PROJECT_PATH=./src/my-app +```