Skip to content

Commit 0254b3a

Browse files
authored
more grammar fixes
1 parent 52cc765 commit 0254b3a

1 file changed

Lines changed: 28 additions & 13 deletions

File tree

README.md

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ Once you clone the new repo to your laptop and open VSCode (with the [InterSyste
2222
Make sure you have [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [Docker desktop](https://www.docker.com/products/docker-desktop) installed.
2323

2424
## Installation
25+
2526
Clone/git pull the repo into any local directory
27+
2628
```
2729
$ git clone https://github.com/intersystems-community/intersystems-iris-dev-template.git
2830
```
@@ -34,19 +36,22 @@ $ docker-compose up -d
3436
```
3537

3638
To open IRIS Terminal do:
39+
3740
```
3841
$ docker-compose exec iris iris session iris -U IRISAPP
3942
IRISAPP>
4043
```
4144

4245
To exit the terminal, do any of the following:
46+
4347
```
4448
Enter HALT or H (not case-sensitive)
4549
```
50+
4651
## What does it do
4752
THe sample repository contains two simplest examples of ObjectScript classes: ObjectScript method that returns value and method that creates a persistent record.
48-
1.
49-
Open IRIS terminal and run the ObjectScript Test() method to see if runs the script and returns values from IRIS:
53+
54+
1. Open IRIS terminal and run the ObjectScript Test() method to see if runs the script and returns values from IRIS:
5055

5156
```
5257
$ docker-compose exec iris iris session iris -U IRISAPP
@@ -57,37 +62,46 @@ It works!
5762

5863

5964

60-
2.
61-
Class dc.sample.PersistentClass contains a method CreateRecord that creates an object with one property Test and returns its id.
65+
2. Class `dc.sample.PersistentClass` contains a method `CreateRecord` that creates an object with one property, `Test`, and returns its id.
66+
6267
Open IRIS terminal and run:
68+
6369
```
6470
IRISAPP>write ##class(dc.sample.PersistentClass).CreateRecord(.id)
6571
1
6672
IRISAPP>write id
6773
1
6874
```
75+
6976
In your case the value of id could be different. And it will be different with every call of the method.
7077

7178
You can check whether the record exists and try to right the property of the object by its id.
79+
7280
```
7381
IRISAPP>write ##class(dc.sample.PersistentClass).ReadProperty(id)
7482
Test string
7583
```
7684

7785
## How to start the development
78-
This repository is ready to code in VSCode with ObjectScript plugin.
86+
87+
This repository is ready to code in VSCode with the ObjectScript plugin.
88+
7989
Install [VSCode](https://code.visualstudio.com/), [Docker](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) and the [InterSystems ObjectScript Extension Pack](https://marketplace.visualstudio.com/items?itemName=intersystems-community.objectscript-pack) plugin and open the folder in VSCode.
80-
Open /src/cls/PackageSample/ObjectScript.cls class and try to make changes - it will be compiled in running IRIS docker container.
90+
91+
Open the `/src/cls/PackageSample/ObjectScript.cls` class and make changes - it will be compiled in the running IRIS docker container.
92+
8193
![docker_compose](https://user-images.githubusercontent.com/2781759/76656929-0f2e5700-6547-11ea-9cc9-486a5641c51d.gif)
8294

83-
Feel free to delete PackageSample folder and place your ObjectScript classes in the form
84-
/src/organisation/package/Classname.cls
85-
[Read more about folder setup for InterSystems ObjectScript](https://community.intersystems.com/post/simplified-objectscript-source-folder-structure-package-manager)
86-
and her on the [naming convention]()
95+
Feel free to delete the PackageSample folder and place your ObjectScript classes in the form
96+
`/src/organisation/package/Classname.cls`
97+
98+
[Read more about folder setup for InterSystems ObjectScript](https://community.intersystems.com/post/simplified-objectscript-source-folder-structure-package-manager) and here on the [naming convention]()
8799

88100
## Running unit tests
89-
The template contains to test classes: `TestObjectScript.cls` and `TestPersistentClass.cls `
90-
To run the unit tests we can use Package Manager environment.
101+
102+
The template contains two test classes: `TestObjectScript.cls` and `TestPersistentClass.cls `
103+
104+
To run the unit tests we can use the Package Manager environment.
91105

92106
```
93107
IRISAPP>zpm
@@ -136,7 +150,8 @@ All PASSED
136150
zpm:IRISAPP>
137151
```
138152

139-
In case of test errors you can check it back in the UnitTest portal, that can be easily opened via ObjectScript menu in VSCode:
153+
In case of test errors, you can find more details back in the UnitTest portal, which can be easily opened via ObjectScript menu in VSCode:
154+
140155
![vscvode unittest](https://user-images.githubusercontent.com/2781759/152678943-7d9d9696-e26a-449f-b1d7-f924528c8e3a.png)
141156

142157
## What else is inside the repository

0 commit comments

Comments
 (0)