From 4c0fc8b67e71fcfa0848453bde33fb094f562ff6 Mon Sep 17 00:00:00 2001 From: Evgeny Shvarov Date: Mon, 7 Aug 2017 13:56:30 -0400 Subject: [PATCH] Update README.md --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index fe92e1a..bf67925 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ import the [release](https://github.com/intersystems-ru/cache-udl/releases) to t Map sc package to %All namespace to make it visible in any namespace. +# Usage + ## Setup working directory ( optional ) ``` NS> w ##class(sc.code).workdir("/path/to/your/working/directory/") @@ -23,3 +25,29 @@ NS> d ##class(sc.code).export() ``` NS> d ##class(sc.code).import() ``` + +## Compile and Release: + +Introduce cos.json file in the source root directory with settings for the code mask and for the name of the project. e.g. +``` +cos.json + "compileList": "Classes*.INC,classes*.CLS,*.DFI", + "projectName": "myproject" +``` +Run init method to initialize project settings: +``` +NS> d ##class(sc.code).init() +``` +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. +``` +NS> d ##class(sc.code).release() +``` +Or compile it whenever you want to compile all the proejct related resources. +``` +NS> d ##class(sc.code).compile() +``` + + + + +