Merge pull request #8 from intersystems-community/isc-rsingh-patch-1

Author: evshvarov

README.md

@@ -4,19 +4,19 @@
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=flat&logo=AdGuard)](LICENSE)
 # intersystems-iris-dev-template
-This is a basic template of a dev environment to  edit, make a package module, compile, debug, test,  commit/push the objectscript code with InterSystems IRIS. 
+This is a basic template for a development environment to work with ObjectScript in InterSystems IRIS. It helps you edit, compile, commit/push, debug and test your ObjectScript code. It also aids in packaging your application as a module installable with ZPM. 
 
 ## Description
-The idea of the repository is to provide a read-to-go dev environment if one needs to code InterSystems ObjectScript.
-* The template runs InterSystems IRIS Community Edition running in a docker container
-* It creates a fresh new namespace and database IRISAPP
-* It loads the ObjectScript code into IRISAPP database using  Package Manager 
-* It suggests development with 'Package First' paradigm. Watch the video](https://www.youtube.com/watch?v=havPyPbUj1I)
-* Provides unittests environment: sample unittests, tests module enablement
+This repository provides a read-to-go development environment for coding productively with InterSystems ObjectScript. This template:
+* Runs InterSystems IRIS Community Edition in a docker container
+* Creates a new namespace and database IRISAPP
+* Loads the ObjectScript code into IRISAPP database using Package Manager 
+* Promotes development with the 'Package First' paradigm. [Watch the video](https://www.youtube.com/watch?v=havPyPbUj1I)
+* Provides a unit testing environment: sample unit tests, tests module enablement
 
 ## Usage
-start a new dev repository with InterSystems IRIS using this one as a template.
-Once you clone the new repo on your laptop and open the VSCode with installed InterSystems Pack you'll be able to start development immediately
+Start a new dev repository with InterSystems IRIS using this one as a template.
+Once you clone the new repo to your laptop and open VSCode (with the [InterSystems ObjectScript Extension Pack](https://marketplace.visualstudio.com/items?itemName=intersystems-community.objectscript-pack) installed) you'll be able to start development immediately.
 
 ## Prerequisites
 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.
@@ -74,21 +74,21 @@ IRISAPP>write ##class(dc.sample.PersistentClass).ReadProperty(id)
 Test string
 ```
 
-
 ## How to start the development
 This repository is ready to code in VSCode with ObjectScript plugin.
-Install [VSCode](https://code.visualstudio.com/), [Docker](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) and [ObjectScript](https://marketplace.visualstudio.com/items?itemName=daimor.vscode-objectscript) plugin and open the folder in VSCode.
+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.
 Open /src/cls/PackageSample/ObjectScript.cls class and try to make changes - it will be compiled in running IRIS docker container.
 ![docker_compose](https://user-images.githubusercontent.com/2781759/76656929-0f2e5700-6547-11ea-9cc9-486a5641c51d.gif)
 
-Feel free to delete PackageSample folder and place your ObjectScript classes in a form
+Feel free to delete PackageSample folder and place your ObjectScript classes in the form
 /src/organisation/package/Classname.cls
 [Read more about folder setup for InterSystems ObjectScript](https://community.intersystems.com/post/simplified-objectscript-source-folder-structure-package-manager)
 and her on the [naming convention]()
 
-## running unittests
-The template contains to test classes: TestObjectScript.cls and TestPersistentClass.cls 
-To run the unittests we can use Package Manager environment.
+## Running unit tests
+The template contains to test classes: `TestObjectScript.cls` and `TestPersistentClass.cls `
+To run the unit tests we can use Package Manager environment.
+
 ```
 IRISAPP>zpm
 
@@ -135,55 +135,63 @@ All PASSED
 [dc-sample-template]    Test SUCCESS
 zpm:IRISAPP>
 ```
+
 In case of test errors you can check it back in the UnitTest portal, that can be easily opened via ObjectScript menu in VSCode:
 ![vscvode unittest](https://user-images.githubusercontent.com/2781759/152678943-7d9d9696-e26a-449f-b1d7-f924528c8e3a.png)
 
 ## What else is inside the repository
 
 ### .github folder
-it contains to github actions workflows: 
-1. github-registry.yml 
+
+Contains two GitHub actions workflows: 
+1. `github-registry.yml` 
     Once changes pushed to the repo, the action builds the docker image on Github side and pushes the image to Github registry that can be very convenient to further cloud deployement, e.g. kubernetes.
-2. objectscript-qaulity.yml
+2. `objectscript-qaulity.yml`
     with every push to master or main branch the workflow launches the repo test on objectscript issues with Objectscript Quality tool, [see the examples](https://community.objectscriptquality.com/projects?sort=-analysis_date). This works if the repo is open-source only.
 
 Both workflows are repo agnostic: so they work with any repository where they exist.
 
 ### .vscode folder
-it contains to files to setup vscode environment:
+Contains two files to setup vscode environment:
+
 #### .vscode/settings.json
 
-Settings file to let you immedietly code in VSCode with [VSCode ObjectScript plugin](https://marketplace.visualstudio.com/items?itemName=daimor.vscode-objectscript))
+Settings file to let you immediately code in VSCode with [VSCode ObjectScript plugin](https://marketplace.visualstudio.com/items?itemName=daimor.vscode-objectscript))
 
 #### .vscode/launch.json
-Config file if you want to debug with VSCode ObjectScript
 
+Config file if you want to debug with VSCode ObjectScript
 
 ### src folder
-contains source files.
+
+Contains source files.
 src/iris contains InterSystems IRIS Objectscript code
 
 ### tests folder
-contains unittests for the ObjectScript classes
+Contains unit tests for the ObjectScript classes
 
 ### dev.md
-contains a set of useful commands that will help during the development
+
+Contains a set of useful commands that will help during the development
 
 ### docker-compose.yml
-a docker engine helper file to manage images building and rule ports mapping an the host to container folders(volumes) mapping
+
+A docker engine helper file to manage images building and rule ports mapping an the host to container folders(volumes) mapping
+
 ### Dockerfile
 
 The simplest dockerfile which starts IRIS and imports code from /src folder into it.
 Use the related docker-compose.yml to easily setup additional parametes like port number and where you map keys and host folders.
 
 
 ### iris.script
-contains objectscript commands that are feeded to iris during the image building
+
+Contains objectscript commands that are feeded to iris during the image building
 
 ### module.xml
+
 IPM Module's description of the code in the repository.
 It describes what is loaded with the method, how it is being tested and what apps neeed to be created, what files need to be copied.
 
-
 [Read about all the files in this artilce](https://community.intersystems.com/post/dockerfile-and-friends-or-how-run-and-collaborate-objectscript-projects-intersystems-iris)