From 359c7012a1db8473a8235d696d622228fc2c57e0 Mon Sep 17 00:00:00 2001 From: Christian Kihm-Landau Date: Wed, 17 Jul 2024 11:18:18 +0200 Subject: [PATCH] add devcontainer installation instruction --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index be5c96d..4fab4d2 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,43 @@ Navigate to the [latest release](https://github.com/rvr06/cornifer/releases/late Then, within VSCode, open the `Extensions` view, select for `Install from VSIX` from `Views and more actions` button and browse to the `.vsix`. +To automate the installation of the extension in a devcontainer, follow these steps: + +1. Place the `.vsix` file in the repository under the `.devcontainer` directory, for example, `.devcontainer/extensions/cornifer-.vsix`. + +2. Make the extension available to the devcontainer by adding it as a volume, e.g. in case you use compose add the extention folder als volume in the `docker-compose.yml`: + +```yaml +version: '3' + +services: + app: + build: + context: . + dockerfile: Dockerfile + + volumes: + # Update this to wherever you want VS Code to mount the folder of your project + - ../..:/workspaces:cached + # Unpublished extensions + - ./extensions:/extensions +``` + +3. Finally, install the extension in the devcontainer.json: + +```json +"customizations": { + "vscode": { + "extensions": [ + "/extensions/cornifer-.vsix" + ] + } +} +``` + +> **Note:** An error may be displayed in the editor indicating that the format for defining the extension is not supported. This is a bug; the format is supported and this will install an extension from the container's filesystem. + + ## Overview of the extension features ### Format document