Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
David Freiberger committed Jun 1, 2024
1 parent 8e7f162 commit 97d98e6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This unofficial extension allows previewing of Beckhoff TwinCAT 3 files within Azure DevOps. The source code is available on [GitHub](https://github.com/dfreiberger/tc-preview-extension).

It currently supports the `.TcPOU`, `.TcDUT`, `.TcGVL` and `.TcIO` file extensions. Only Structured Text (ST) is supported, so any sections of the code that are in another format such as LD, FBD or UML will not be displayed.
It currently supports the `.TcPOU`, `.TcDUT`, `.TcGVL` and `.TcIO` file extensions.

To see a preview of a file, open it from `Repos > Files` and select the Preview tab. You can also see previews within pull requests or from the search view.

Expand All @@ -12,6 +12,14 @@ It is also possible to copy a link to a specific section of code by clicking the

Pull requests are welcome.

## Limitations

Only Structured Text (ST) is supported, so any sections of the code that are in another format such as LD, FBD or UML will not be displayed.

The Copy link feature only works for the default branch, or for branches that have been actively selected by choosing them in the branch dropdown first before copying the link. This appears to be a limitation of Azure DevOps and the same issue is present when copying links to normal source files.

![Image of select branch dropdown](img/branch_selection.png "Select branch dropdown")

## Development

To develop locally, create an Azure DevOps organization and publish this extension in dev mode to it.
Expand Down
Binary file added img/branch_selection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 97d98e6

Please sign in to comment.