Skip to content
This repository has been archived by the owner on Sep 12, 2024. It is now read-only.

Commit

Permalink
docs: tweaks to vscode extension description
Browse files Browse the repository at this point in the history
  • Loading branch information
marsninja committed Jun 11, 2024
1 parent 7f52a4a commit d038fe8
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 38 deletions.
36 changes: 1 addition & 35 deletions support/vscode_ext/jac/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,7 @@ This extension provides support for the [Jac](https://doc.jaseci.org) programmin

# Quick Start

When you install the extension you will need to add a setting to your `settings.json` file that points to the python path of your Jaseci environment.

1. Activate your python environment where for which Jaseci is installed.
2. Create a `.vscode/settings.json` file in your project root if one is not already present.
3. Go to your terminal and run `which python` and copy the path.
4. Update your `settings.json` file in the `.vscode` directory by adding `jac.pythonPath` to the settings object with the path you copied.

Example:

```json
{
"jac.pythonPath": "/Users/john_doe/mambaforge/envs/jac/bin/python"
}
```
All that is needed is to have jac installed (i.e. `pip install jaclang`) and the `jac` command line tool present in your environment.

# Features

Expand All @@ -28,24 +15,3 @@ Example:
- Document symbols, workspace symbols
- Variables hint, and documentation on hover
- Diagnostics

# Contributing

## Install Server Dependencies

1. `python -m venv env`
2. `python -m pip install -e .` from root directory
3. Create `.vscode/settings.json` file and set `jac.pythonPath` to point to your python environment where `jaseci` is installed

## Install Client Dependencies

Open terminal and execute following commands:

1. `yarn install`
1. `cd client/ && yarn install`

## Run Extension

1. Open this directory in VS Code
2. Open debug view (`ctrl + shift + D`)
3. Select `Server + Client` and press `F5`
2 changes: 1 addition & 1 deletion support/vscode_ext/jac/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "jaclang-extension",
"version": "2024.6.12",
"version": "2024.6.13",
"displayName": "%extension.displayName%",
"description": "%extension.description%",
"publisher": "jaseci-labs",
Expand Down
4 changes: 2 additions & 2 deletions support/vscode_ext/jac/package.nls.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"extension.displayName": "Jac",
"extension.description": "Jaclang is a graph based programming language for AI and ML. This extension provides syntax highlighting , completion, formatting, and linting for Jaclang."
}
"extension.description": "Jac is a programming language for the era of AI and Cloud that super-sets Python. This extension provides syntax highlighting , completion, formatting, and linting for Jac."
}

0 comments on commit d038fe8

Please sign in to comment.