Skip to content

Commit 5ec2592

Browse files
authored
Update README.md
1 parent beb6cd8 commit 5ec2592

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ This is a template for InterSystems ObjectScript Github repository.
33
The template goes also with a few files which let you immedietly compile your ObjecScript files in InterSystems IRIS Community Edition in a docker container
44

55
## Prerequisites
6-
This needs to have git and docker installed.
6+
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.
77

88
## Installation
99

1010
Clone/git pull the repo into any local directory
1111

1212
```
13-
$ git clone https://github.com/your-repository.git
13+
$ git clone https://github.com/intersystems-community/objectscript-docker-template.git
1414
```
1515

1616
Open the terminal in this directory and run:
@@ -36,35 +36,39 @@ IRISAPP>write ##class(PackageSample.ObjectScript).Test()
3636
```
3737
## How to start coding
3838
This repository is ready to code in VSCode with ObjectScript plugin.
39-
Install [VSCode](https://code.visualstudio.com/) and [ObjectScript](https://marketplace.visualstudio.com/items?itemName=daimor.vscode-objectscript) plugin and open the folder in VSCode.
39+
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.
4040
Open /src/cls/PackageSample/ObjectScript.cls class and try to make changes - it will be compiled in running IRIS docker container.
4141

4242
Feel free to delete PackageSample folder and place your ObjectScript classes in a form
43-
/src/cls/Package/Classname.cls
43+
/src/Package/Classname.cls
44+
[Read more about folder setup for InterSystems ObjectScript](https://community.intersystems.com/post/simplified-objectscript-source-folder-structure-package-manager)
4445

45-
The script in Installer.cls will import everything you place under /src/cls into IRIS.
46+
The script in Installer.cls will import everything you place under /src into IRIS.
4647

47-
## What's insde the repo
4848

49-
# Dockerfile
49+
## What's inside the repository
50+
51+
### Dockerfile
5052

5153
The simplest dockerfile which starts IRIS and imports Installer.cls and then runs the Installer.setup method, which creates IRISAPP Namespace and imports ObjectScript code from /src folder into it.
5254
Use the related docker-compose.yml to easily setup additional parametes like port number and where you map keys and host folders.
5355
Use .env/ file to adjust the dockerfile being used in docker-compose.
5456

55-
# Dockerfile-zpm
57+
### Dockerfile-zpm
5658

5759
Dockerfile-zpm builds for you a container which contains ZPM package manager client so you are able to install packages from ZPM in this container.
5860
As an example of usage in installs webterminal
5961

60-
# Dockerfile-web
62+
### Dockerfile-web
6163

6264
Dockerfile-web starts IRIS does the same what Dockerfile does and also sets up the web app programmatically
6365

6466

65-
# .vscode/settings.json
67+
### .vscode/settings.json
6668

6769
Settings file to let you immedietly code in VSCode with [VSCode ObjectScript plugin](https://marketplace.visualstudio.com/items?itemName=daimor.vscode-objectscript))
6870

69-
# .vscode/launch.json
71+
### .vscode/launch.json
7072
Config file if you want to debug with VSCode ObjectScript
73+
74+
[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)

0 commit comments

Comments
 (0)