From ab8eff8344f707459308f29e09d5b016a79390cc Mon Sep 17 00:00:00 2001 From: Chris Simon Date: Tue, 12 Mar 2024 06:56:21 +0000 Subject: [PATCH] docs: add link to installation instructions to each plugin/extension's README --- src/intellij/contextive/README.md | 4 ++++ src/vscode/contextive/README.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/src/intellij/contextive/README.md b/src/intellij/contextive/README.md index b4912d7f..cc26a4b6 100644 --- a/src/intellij/contextive/README.md +++ b/src/intellij/contextive/README.md @@ -4,6 +4,10 @@ Contextive is an IntelliJ Platform Plugin to assist developers in environments w It should help new team members get up to speed more quickly in understanding domain-specific terms. By storing the term definitions in your repository, and surfacing the definitions as you work on the code, it encourages the use of the domain-specific terms in your code, and regularly updating the definitions as the team's understanding evolves. +## Installation + +See [IntelliJ IDEs (e.g. IDEA, Rider) Installation Instructions](https://github.com/dev-cycles/contextive/blob/main/docs/wiki/INSTALLATION.md#intellij-plugin-platform). + ## Getting Started Create a folder in your project root called `.contextive`. Create a file in that folder called `definitions.yml`. diff --git a/src/vscode/contextive/README.md b/src/vscode/contextive/README.md index beaf3511..e1c38bfb 100644 --- a/src/vscode/contextive/README.md +++ b/src/vscode/contextive/README.md @@ -9,6 +9,10 @@ It should help new team members get up to speed more quickly in understanding do ![Example of Contextive in action.](../../../docs/wiki/images/simple-auto-complete-demo.gif) +## Installation + +See [VsCode Installation Instructions](../../../docs/wiki/INSTALLATION.md#visual-studio-code). + ## Getting Started Use the `Contextive: Initialize Definitions` command from the command palette to create a sample definitions file. A file will be created and opened with a sample set of definitions: