Skip to content

Commit

Permalink
root morphir-ir
Browse files Browse the repository at this point in the history
  • Loading branch information
reebayroo committed Sep 5, 2024
1 parent 005e1c0 commit 9e3df56
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,7 @@ tests-integration/reference-model/Dockerfile
*Debug.log*
tests-integration/cli2-qa-test/test-data/.DS_Store
tests-integration/cli2-qa-test/test-data/business-terms/.DS_Store
tests-integration/typespec/model/morphir-ir.json
tests-integration/json-schema/model/morphir-ir.json
tests-integration/reference-model/morphir-ir.json
/morphir-ir.json
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ root directory with the following structure:
{
"name": "My.Package",
"sourceDirectory": "src",
"dependencies" : ["a", "b"]
"localDependencies" : ["a", "b"]
"exposedModules": [
"Foo",
"Bar"
Expand All @@ -82,7 +84,12 @@ root directory with the following structure:
* **name** - The name of the package. The package name should be a valid Elm module name and it should be used as a
module prefix in your Elm models. If your package name is `My.Package` all your module files should either be directly
under that or in submodules.

* **sourceDirectory** - The directory where your Elm sources are located.
* **dependencies** - List of URI references to other IR files. Supports
`file://`|`http://`|`https://`|`data://` protocols.
* **localDependencies** - List of relative paths to depending IRs. (for backwards compatibility)
`file://`|`http://`|`https://`|`data://` protocols.
* **exposedModules** - The list of modules in the public interface of the package. Module names should exclude the
common package prefix. In the above example `Foo` refers to the Elm module `My.Package.Foo`.

Expand Down

0 comments on commit 9e3df56

Please sign in to comment.