Skip to content

Commit

Permalink
docs: add link to installation instructions to each plugin/extension'…
Browse files Browse the repository at this point in the history
…s README
  • Loading branch information
chrissimon-au committed Mar 12, 2024
1 parent edd3197 commit ab8eff8
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/intellij/contextive/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
4 changes: 4 additions & 0 deletions src/vscode/contextive/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit ab8eff8

Please sign in to comment.