stevedlawrence commented on code in PR #174:
URL: https://github.com/apache/daffodil-vscode/pull/174#discussion_r895950137


##########
README.md:
##########
@@ -89,6 +89,21 @@ Once you have either downloaded the VSIX file or created it 
you can now install
 
 Please refer to the Wiki page at https://github.com/apache/daffodil-vscode/wiki
 
+To debug a daffodil schema, choose open a folder from the File menus, then 
select a dfdl.xsd file. Once the file loads in VS Code, then set a desired 
breakpoint.
+![Setting Breakpoints](./images/SetBreakpoint.gif)
+
+To start debugging, click on the debug button on the side panel, then click 
the RUN AND DEBUG button with the dropdown set to Ask for file name.
+![Debugging](./images/StartDebug.gif)
+
+To step through the schema code, use the step over button
+![Step Over](./images/StepThrough.gif)
+
+To view the infoset, use the veiw the XML infoset button
+![View Infoset](./images/ViewInfoset.gif)
+
+To view the data file in hex, use the view hex button
+![View Hex](./images/ViewHex.gif)
+

Review Comment:
   These images are very wide, like 1800 pixels. When they are rendered in a 
github readme, e.g.
   
   
https://github.com/apache/daffodil-vscode/blob/f838c5c753e97aeed30c71db76d56396e34e40b3/README.md
   
   They end up getting scaled down to fit the width and so we lose a lot of 
quality--images get blurry and bit hard to read. It looks like anything over 
1012 pixels is going to get scaled. I'd suggest creating these with a smaller 
VS Code window so they fit the full width of a github page without needing to 
be scaled.



##########
README.md:
##########
@@ -89,6 +89,21 @@ Once you have either downloaded the VSIX file or created it 
you can now install
 
 Please refer to the Wiki page at https://github.com/apache/daffodil-vscode/wiki
 
+To debug a daffodil schema, choose open a folder from the File menus, then 
select a dfdl.xsd file. Once the file loads in VS Code, then set a desired 
breakpoint.

Review Comment:
   We have a link to the wiki which looks to show very similar things. I'm not 
sure we need them both in the wiki and here. The wiki seems to have more 
information.



##########
README.md:
##########
@@ -89,6 +89,21 @@ Once you have either downloaded the VSIX file or created it 
you can now install
 
 Please refer to the Wiki page at https://github.com/apache/daffodil-vscode/wiki
 
+To debug a daffodil schema, choose open a folder from the File menus, then 
select a dfdl.xsd file. Once the file loads in VS Code, then set a desired 
breakpoint.
+![Setting Breakpoints](./images/SetBreakpoint.gif)
+
+To start debugging, click on the debug button on the side panel, then click 
the RUN AND DEBUG button with the dropdown set to Ask for file name.
+![Debugging](./images/StartDebug.gif)

Review Comment:
   This GIF goes really fast, its hard to tell what it's actually trying to 
show. Does this add anything new that's not on the wiki?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to