Skip to content

Commit

Permalink
[#68] Integrate Model Orphans Reporting
Browse files Browse the repository at this point in the history
Improving documentation in README.md
  • Loading branch information
danielsiegl committed Feb 11, 2025
1 parent ec36929 commit 4c40df1
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 1 deletion.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -354,3 +354,6 @@ src/Models/GPUCache/data_2
src/Models/GPUCache/data_3
src/Models/GPUCache/index
*.ldb
/.obsidian/appearance.json
/.obsidian/core-plugins.json
/.obsidian/workspace.json
1 change: 1 addition & 0 deletions .obsidian/app.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,27 @@ https://nexus.lieberlieber.com/#browse/browse:lemontree-pipeline-tools
Used to check Models for LemonTree Readiness.
https://nexus.lieberlieber.com/repository/lemontree-pipeline-tools/LemonTree.Pipeline.Tools.ModelCheck.exe

### Commandline Reference

```
--Out File to output .md e.g.: 'out.md'
--NoCompact If set the Checks that compact the Model are not run!
--FailOnErrors If set the Exitcode will be 2 if there is at least on Check of Status Error!
--FailOnWarnings If set the Exitcode will be 1 if there is at least on Check of Status Warning!
--TableSize If set the size of the tables in the database will be reported!
--Orphans If set Model Orphans will be reported!
--Model Required. The 'Model' used for the operation.
--help Display this help screen.
--version Display version information.
```

### Powershell Example:
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ internal class ModelCheckOptions:BaseOptions
[Option("TableSize", Required = false, HelpText = "If set the size of the tables in the database will be reported!")]
public bool TableSize { get; set; }

[Option("Orphans", Required = false, HelpText = "If Model Orphans will be reported!")]
[Option("Orphans", Required = false, HelpText = "If set Model Orphans will be reported!")]
public bool Orphans { get; set; }
}
}

0 comments on commit 4c40df1

Please sign in to comment.