Skip to content

Commit 4c0fc8b

Browse files
authored
Update README.md
1 parent 6640598 commit 4c0fc8b

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ import the [release](https://github.com/intersystems-ru/cache-udl/releases) to t
1111

1212
Map sc package to %All namespace to make it visible in any namespace.
1313

14+
# Usage
15+
1416
## Setup working directory ( optional )
1517
```
1618
NS> w ##class(sc.code).workdir("/path/to/your/working/directory/")
@@ -23,3 +25,29 @@ NS> d ##class(sc.code).export()
2325
```
2426
NS> d ##class(sc.code).import()
2527
```
28+
29+
## Compile and Release:
30+
31+
Introduce cos.json file in the source root directory with settings for the code mask and for the name of the project. e.g.
32+
```
33+
cos.json
34+
"compileList": "Classes*.INC,classes*.CLS,*.DFI",
35+
"projectName": "myproject"
36+
```
37+
Run init method to initialize project settings:
38+
```
39+
NS> d ##class(sc.code).init()
40+
```
41+
Then run release to export all the classes in comileList into one "myproject.xml" release file. It will export it into the default for current Namespace directory.
42+
```
43+
NS> d ##class(sc.code).release()
44+
```
45+
Or compile it whenever you want to compile all the proejct related resources.
46+
```
47+
NS> d ##class(sc.code).compile()
48+
```
49+
50+
51+
52+
53+

0 commit comments

Comments
 (0)