Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add devcontainer installation instruction #7

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-<version>.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`:
autrk marked this conversation as resolved.
Show resolved Hide resolved

```yaml
version: '3'

services:
app:
build:
context: .
dockerfile: Dockerfile
autrk marked this conversation as resolved.
Show resolved Hide resolved

volumes:
# Update this to wherever you want VS Code to mount the folder of your project
- ../..:/workspaces:cached
# Unpublished extensions
- ./extensions:/extensions
```
autrk marked this conversation as resolved.
Show resolved Hide resolved

3. Finally, install the extension in the devcontainer.json:

```json
"customizations": {
"vscode": {
"extensions": [
"/extensions/cornifer-<version>.vsix"
]
}
}
```
autrk marked this conversation as resolved.
Show resolved Hide resolved
autrk marked this conversation as resolved.
Show resolved Hide resolved

> **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
Expand Down