Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md updated with latest ModelGeneratorOptions and Prerequisites. #18

Merged
merged 6 commits into from
Oct 20, 2022
Merged

README.md updated with latest ModelGeneratorOptions and Prerequisites. #18

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2f03f65
README.md updated with latest ModelGeneratorOptions and Prerequisotes.
Aug 31, 2022
0b2ceda
Updated README.md with limitations of the model generator
Sep 1, 2022
fe7ed65
Updated ReadMe format and removed nuget package information
Sep 13, 2022
a090712
Updated ReadMe with Model generator limitations
Sep 22, 2022
05e3d9e
Add support for duration primitive (#19) (#20)
NancyGargMS Oct 13, 2022
ac0ea09
Revert "Add support for duration primitive (#19)" (#21)
NancyGargMS Oct 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,36 @@ This Digital Twin Definition Language (DTDL) Model Generator parses your DTDL js
- *Namespace*: The namespace that will be injected into the generated model classes.
- *JsonModelsDirectory*: The directory that contains the DTDL json files that we'll be parsing.
- *OutputDirectory*: The directory that the generated model classes will be placed in.
- *IncludeTemplateProject*: Whether or not to include the template project in the output directory.
- *CopyrightHeader*: The header comment that contains copyright information.

## Prerequisites
The following are some Prerequisites/assumptions to be considered:

For Developers
jarz marked this conversation as resolved.
Show resolved Hide resolved
- .Net 6 must be installed, while building the model generator locally. Backward compatibility is not supported.
- The system should have GIT installed as the model generator uses MinVer package which requires GIT.
NancyGargMS marked this conversation as resolved.
Show resolved Hide resolved

For Users
jarz marked this conversation as resolved.
Show resolved Hide resolved
- The following classes have been copied at the location where model generator assembly is being executed:
"Extensions.cs",
"ModelHelper.cs",
"Relationship.cs",
"RelationshipCollection.cs",
"RelationshipEqualityComparer.cs",
"SourceValueAttribute.cs",
"TwinEqualityComparer.cs"
jarz marked this conversation as resolved.
Show resolved Hide resolved
- The ModelGeneratorOptions property "CopyrightHeader" should have "// " prefix.
- The following NuGet packages references should be added:
Azure.DigitalTwins.Core(1.2.2)
Microsoft.Azure.DigitalTwins.Parser(3.12.7)
MinVer(3.1.0)
StyleCop.Analyzers(1.1.118)
System.Text.RegularExpressions(4.3.1)
NancyGargMS marked this conversation as resolved.
Show resolved Hide resolved

## Limitations
- The model generator do not support Telemetry fields and Component.
ms-mikeb marked this conversation as resolved.
Show resolved Hide resolved
- The model generator do not support Duration and Array schema types for property and telemetry attributes.
- It also does not support Semantic type with Telemetry fields.

## Usage

Expand Down