Shanedell commented on a change in pull request #37: URL: https://github.com/apache/daffodil-vscode/pull/37#discussion_r739284524
########## File path: README.md ########## @@ -21,13 +21,65 @@ This is a VS Code extension which enables the interactive debugging of DFDL schema parsing using [Apache Daffodil](https://daffodil.apache.org/). +## Build Requirements +- Java Development Kit (JDK) 11 or higher +- SBT 0.13.8 or higher +- Node 10 or higher +- Yarn (https://yarnpkg.com/getting-started/install) + +## Download - Prebuilt + +Until the extension is available in the [VS Code Extension Marketplace](https://marketplace.visualstudio.com/vscode), please download the latest `.vsix` file from the [releases page](https://github.com/apache/daffodil-vscode/releases). + + +## Build VSIX and Debugger +:exclamation:**NOT necessary if using prebuilt VSIX**:exclamation: + +:exclamation:**NOT necessary if debugging extension but a `yarn install` will be required**:exclamation: + +* Note what the dapodil data folder location for your OS is. + * Linux = `/home/USERNAME/.local/share/dapodil` + * Mac = `/Users/USERNAME/Library/Application\ Support/dapodil` + * Windows = `C:\\Users\\USERNAME\\AppData\\Roaming\\dapodil` + + :exclamation: Ensure this folder location exists :exclamation: + +* Run full build + ```bash + yarn build + ``` + + * Create sbt zip package + * Install dependencies + * Compiles Extension + * Packages Extension + * Files + ``` + server/core/target/universal/daffodil-debugger-*.zip + daffodil-debugger-*.vsix + ``` + +## Backend - Debugger Server +* When debugging the extension locally: Review comment: So I think this should be renamed maybe `Running Debugger Server` to take it clear it is referring to how the debug server will be started up. So for "debugging extension locally" I am referring to running the extension in VSCode instead of using a VSIX file. This section is just referring to how the debug server is started so basically it just says the extension will handle it on its own but maybe should just like the directory that scripts to run the debug server are at if interested in running it manually instead of just by automatically. -- 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]
