Skip to content

Commit

Permalink
Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mohamed ali committed Sep 24, 2021
1 parent ecc86f0 commit f67b3be
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
2 changes: 2 additions & 0 deletions J2dConsole/J2dConsole.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
<OutputType>Exe</OutputType>
<TargetFramework>net5.0</TargetFramework>
<AssemblyName>J2d</AssemblyName>
<ReleaseVersion>1.0.1</ReleaseVersion>
<SynchReleaseVersion>false</SynchReleaseVersion>
</PropertyGroup>

<ItemGroup>
Expand Down
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# JsonToDart

A Dotnet App to create dart class from json, taking null-safety into consideration
A Dotnet cross-platform App to create dart class from json, taking null-safety into consideration

The dart class extends `Serializable` base class

Expand Down Expand Up @@ -28,3 +28,24 @@ abstract class Serializable {
```



## How to use

### Windows

For windows the app is available as Windows Forms app, and as console app,

for the console app you can provide your json input via a file, the clipboard or just write it in the console, and you can take the output dart code by any of the three ways,

to run it, open the CMD, go to the app folder, and write `j2d`, you will see help text.

### MacOS

For MacOS the app is available as console only, with the same options available for windows console

to run it, open the Terminal app, go to the app folder, write `dotnet j2d.dll`, you will see the help text

### Linux

it should be easy to compile the console app for linux, but it's not yet tested :)

0 comments on commit f67b3be

Please sign in to comment.