Skip to content

Commit

Permalink
README: update some descriptions and add a debug/run section
Browse files Browse the repository at this point in the history
  • Loading branch information
joshtynjala committed Nov 9, 2021
1 parent 7bed8c4 commit 8a3ea1b
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions distribution/src/assembly/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,22 @@ Extension created and maintained by [Josh Tynjala](https://patreon.com/josht). B
- **Signature Help** shows a list of a function's parameters when you call it.
- **Errors and Warnings** are updated in real time as you type (or on save only, if you prefer).
- **Hover** over a symbol to see more details such as types, namespaces, documentation, and more.
- **Go to Definition** with `Ctrl+Click` on any usage of a symbol to open the file where it is defined.
- **Go to Definition** with `Ctrl+Click` on any usage of a symbol to open the file where it is defined. Can be used to see the public API of classes from compiled _.swc_ libraries too.
- **Find All References** for any symbol in the project across all source files.
- **Rename Symbol** for classes, interfaces, methods, and variables.
- **Organize Imports** sorts imports alphabetically, removes unused imports, and adds missing imports.
- **Quick Fixes** to add missing imports, generate missing variables or methods, or convert variables to getters/setters.
- **Outline view** lists all symbols from the current file in a tree.
- **Go to Symbol in Workspace** with `Ctrl+T` and type the name of any symbol in the workspace.
- **Outline view** lists all symbols from the current file in a hierarchical tree.
- **Go to Symbol in Workspace** with `Ctrl+T` and type the name of any symbol to search for it in the workspace.
- **Build Tasks** can compile a project or package an Adobe AIR app with `Ctrl+Shift+B`.
- **Debug** or **Run** SWF projects in Adobe AIR and Flash Player (using the [Debugger for SWF](https://marketplace.visualstudio.com/items?itemName=bowlerhatllc.vscode-swf-debug) extension).
- **Debug** or **Run** Apache Royale (formerly known as FlexJS) projects in web browsers and Node.js.
- **Adobe Animate** integration includes _Test Movie_, _Debug Movie_, and _Publish_.
- **Import Projects** from Adobe Flash Builder or FlashDevelop.

## Help and Support

- [Documentation](https://github.com/BowlerHatLLC/vscode-as3mxml/wiki)
- [Help & Support Forum](https://github.com/BowlerHatLLC/vscode-as3mxml/discussions)
- [Issue Tracker](https://github.com/BowlerHatLLC/vscode-as3mxml/issues)
- [Bug Reports and Feature Requests](https://github.com/BowlerHatLLC/vscode-as3mxml/issues)
- [Official Website](https://as3mxml.com/)

## Minimum Requirements
Expand Down Expand Up @@ -84,6 +82,12 @@ Here's another sample _asconfig.json_ file for a pure ActionScript project targe
}
```

## Debug and Run

Debug and run SWF projects in Adobe AIR or Flash Player by installing the separate [Debugger for SWF](https://marketplace.visualstudio.com/items?itemName=bowlerhatllc.vscode-swf-debug) extension.

Debug and run Apache Royale with Visual Studio Code's built-in support for debugging JavaScript (or install the appropriate extension for debugging in your chosen web browser). Enable the `source-map` compiler option in your _asconfig.json_ file so that oyu may add breakpoints and step through your original _.as_ or _.mxml_ class files.

## Support this project

The [ActionScript & MXML language extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=bowlerhatllc.vscode-as3mxml) is developed by [Josh Tynjala](http://patreon.com/josht) — thanks to the generous support of developers and small businesses in the community. Folks just like you! By [becoming a patron](https://www.patreon.com/bePatron?c=203199), you can join them in supporting the ongoing development of this project.
Expand All @@ -93,4 +97,4 @@ The [ActionScript & MXML language extension for Visual Studio Code](https://mark
Special thanks to the following sponsors for their generous support:

- [Moonshine IDE](https://moonshine-ide.com/)
- [Jackbox Games](https://jackboxgames.com)
- [Jackbox Games](https://jackboxgames.com)

0 comments on commit 8a3ea1b

Please sign in to comment.