Skip to content

Commit 10909d1

Browse files
committed
README Update
1 parent 019c345 commit 10909d1

File tree

1 file changed

+34
-19
lines changed

1 file changed

+34
-19
lines changed

README.md

Lines changed: 34 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
<a href="https://github.com/phil1436/ownobjectscriptextension/releases">
1212
<img src= "https://img.shields.io/github/v/release/phil1436/ownobjectscriptextension?display_name=tag" alt="current release">
1313
</a>
14+
<img alt="Visual Studio Marketplace Installs" src="https://img.shields.io/visual-studio-marketplace/azure-devops/installs/total/PhilippB.ownobjectscriptextension">
1415
<a href="https://github.com/phil1436/ownobjectscriptextension/blob/master/LICENSE">
1516
<img src="https://img.shields.io/github/license/phil1436/ownobjectscriptextension" alt="license">
1617
</a>
@@ -25,13 +26,14 @@
2526
---
2627

2728
- [Features](#features)
28-
- [Create New Wizard _BETA_](#create-new-wizard-_beta_)
29-
- [Add ObjectScript Modifier](#add-objectscript-modifier)
3029
- [Add Method Description](#add-method-description)
3130
- [Make Select Statement](#make-select-statement)
32-
- [Translate Embedded Python _BETA_](#translate-embedded-python-_beta_)
31+
- [Create New Wizard](#create-new-wizard-_beta_)
32+
- [Translate Embedded Python](#translate-embedded-python-_beta_)
3333
- [Requirements](#requirements)
3434
- [Installation](#installation)
35+
- [Install from VSCode Marketplace](#install-from-vscode-marketplace)
36+
- [Install from GitHub](#install-from-github)
3537
- [Workspace](#workspace)
3638
- [Commands](#commands)
3739
- [Own ObjectScript Create](#own-objectscript-create)
@@ -51,14 +53,6 @@
5153

5254
## Features
5355

54-
### `Create New Wizard` _BETA_
55-
56-
Creates a new ObjectScript Class, Message, Business Service or Business Operation similar to the InterSystems Studio Wizard. Just execute the command and follow the instructions.
57-
58-
![DemoCreateNewClass](https://raw.githubusercontent.com/phil1436/ownobjectscriptextension/master/resources/DemoCreateNewClass.gif)
59-
60-
> This feature is still in beta.
61-
6256
<!-- ### `Add ObjectScript Modifier`
6357
6458
This command automatically adds `Set`, `Do` and `Write` to your InterSystems ObjectScript code.
@@ -69,25 +63,33 @@ This command automatically adds `Set`, `Do` and `Write` to your InterSystems Obj
6963

7064
### `Add Method Description`
7165

72-
Generates description templates for your Methods. Just put your cursor in the Method and execute this command. Only works with `Method` and `ClassMethod`.
66+
Generates description templates for your method. Just put your cursor in the method and execute this command. Only works with `Method` and `ClassMethod`.
7367

7468
![demoAddDescription](https://github.com/phil1436/ownobjectscriptextension/raw/master/resources/demoAddDescription.gif)
7569

7670
<img alt="png" src="https://github.com/phil1436/ownobjectscriptextension/raw/master/resources/demoAddDescriptionClassReference.png" width="70%"/>
7771

78-
> Tip: You can change the template in the options.json file.
72+
> Tip: You can change the template with the `Edit Method Description Template` command.
7973
8074
### `Make Select Statement`
8175

82-
Generates a _SELECT_ statement based on the current opened file.
76+
Generates a _SELECT_ statement based on the currently opened file.
8377

8478
![demoMakeSelectStatement](https://github.com/phil1436/ownobjectscriptextension/raw/master/resources/DemoMakeSelectStatement.gif)
8579

8680
> Tip: Install the [SQLTools](https://github.com/mtxr/vscode-sqltools) extension to execute the statement directly in VSCode.
8781
82+
### `Create New Wizard` _BETA_
83+
84+
Creates a new ObjectScript Class, Message, Business Service or Business Operation similar to the InterSystems Studio Wizard. Just execute the command and follow the instructions.
85+
86+
![DemoCreateNewClass](https://raw.githubusercontent.com/phil1436/ownobjectscriptextension/master/resources/DemoCreateNewClass.gif)
87+
88+
> This feature is still in beta.
89+
8890
### `Translate Embedded Python` _BETA_
8991

90-
Translate an ObjectSCript Method to embedded python. Will generate a new method with the same name and the prefix _py_.
92+
Translate an ObjectScript method to embedded python. Will generate a new method with the same name and the prefix _py_.
9193

9294
![demoTranslateEmbeddedPython](https://github.com/phil1436/ownobjectscriptextension/raw/master/resources/demoTranslateEmbeddedPython.gif)
9395

@@ -97,12 +99,21 @@ Translate an ObjectSCript Method to embedded python. Will generate a new method
9799

98100
## Requirements
99101

100-
The [InterSystems ObjectScript Extension](https://intersystems-community.github.io/vscode-objectscript/) should be installed and an active Texteditor with an Intersystems ObjectScript file should be open.
102+
- Visual Studio Code 1.73.0 or higher
103+
- The [InterSystems ObjectScript Extension](https://intersystems-community.github.io/vscode-objectscript/) should be installed and an active Texteditor with an Intersystems ObjectScript file should be open.
101104

102105
---
103106

104107
## Installation
105108

109+
### Install from VSCode Marketplace
110+
111+
- Open the Extensions sidebar in Visual Studio Code
112+
- Search for `OwnObjectScriptExtension`
113+
- Click `Install`
114+
115+
### Install from GitHub
116+
106117
- Clone this repository (recommended under `~/.vscode/extensions`):
107118

108119
```shell
@@ -129,16 +140,16 @@ This extension will create a directory named _ownobjectscriptextension-workspace
129140

130141
### Own ObjectScript Modifier
131142

132-
- `Add ObjectScript Modifier`: Adds `Set`, `Do` and `Write` modifier to your ObjectScript code. See [here](https://github.com/phil1436/ownobjectscriptextension#add-objectscript-modifier) for more information.
143+
- `Add ObjectScript Modifier`: Adds `Set`, `Do` and `Write` modifier to your ObjectScript code. <!-- See [here](https://github.com/phil1436/ownobjectscriptextension#add-objectscript-modifier) for more information. -->
133144
- `Show ObjectScript Keywords`: Shows the current list of keywords.
134145
- `Add ObjectScript Keyword`: Adds an Objectscript keyword to options.json. If a line starts with one of those keywords no modifier will be added.
135146
- `Remove ObjectScript Keyword`: Remove an ObjectScript keyword.
136147

137-
> Tip: Lines starting with a keyword will be ignored.
148+
> Tip: Lines starting with a keyword will be ignored by the command `Add ObjectScript Modifier`.
138149
139150
### Own ObjectScript Comment
140151

141-
- `Add Method Description`: Adds a description template to your Method or ClassMethod. See [here](#add-method-description) for more information.
152+
- `Add Method Description`: Adds a description template to your `Method` or `ClassMethod`. See [here](#add-method-description) for more information.
142153
- `Add Inline Comments`: Adds a comment in the current Method every specified count of lines without any comment (Default is every 5 lines).
143154
- `Edit Method Description Template`: Opens the _MethodDescriptionTemplate.json_ file so can edit the method template. Reload Window after editing.
144155

@@ -198,6 +209,10 @@ The extension will add a new color theme called _InterSystems Real Dark_. You ca
198209

199210
---
200211

212+
View on [Marketplace](https://marketplace.visualstudio.com/items?itemName=PhilippB.ownobjectscriptextension).
213+
214+
---
215+
201216
by [Philipp B.](https://github.com/phil1436)
202217

203218
powered by [InterSystems](https://www.intersystems.com/).

0 commit comments

Comments
 (0)