stevedlawrence commented on a change in pull request #37: URL: https://github.com/apache/daffodil-vscode/pull/37#discussion_r731150976
########## File path: README.md ########## @@ -23,14 +23,79 @@ This is a VS Code extension which enables the interactive debugging of DFDL schema parsing using [Apache Daffodil](https://daffodil.apache.org/). +## Build Requirements +- SDK 8 or higher +- SBT 0.13.8 or higher +- Node 10 or higher -## Installation +## Installation - via release 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). Then install it by either: * using the "Extensions: Install from VSIX" command from within VS Code (open the Command Palette with Shift-Command-P, then type `vsix` to bring up the command and pointing it at the downloaded `vsix` file); or * on the command-line via `code --install-extension <path-to-downloaded-vsix>`. +## Installation - via source + +:exclamation: Currently only Daffodil 3.1.0 is support, will be updated in the future :exclamation: + +Firstly clone the repo: +* apache/daffodil-vscode (https://github.com/apache/daffodil-vscode) + +Backend - Debugger: +* Note down the current version listed in `package.json`, eg `1.0.0` + * Referenced later as `${package.json_version}` +* 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: + +* Create daffoil debugger zip + ```bash + sbt universal:packageBin + ``` + * Package will be at + ``` + server/core/target/universal/daffodil-debugger-3.1.0-${package.json_version}.zip + ``` + eg + ``` + server/core/target/universal/daffodil-debugger-3.1.0-1.0.0.zip + ``` + +* Unzip debugger zip in data folder + ``` + unzip server/core/target/universal/daffodil-debugger-3.1.0-${package.json_version}.zip -d ~/Library/Application\ Support/dapodil + ``` Review comment: Can the .jar files be included in the .vsix file that is distributed? That avoids having to either download the jar or manually set things up in the directory. From a user perspective, it seems like this would be the preferred way to install an extension--no one wants to manually deal with dependencies. Any idea how big of a code change that would be? Simplified packaging to keep the barrier to entry as simple as possible for a first release seems fairly important. -- 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]
