stevedlawrence commented on a change in pull request #37: URL: https://github.com/apache/daffodil-vscode/pull/37#discussion_r738320595
########## File path: README.md ########## @@ -21,14 +21,59 @@ 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) -## Installation +## Download -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>`. +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 +* 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 + ``` + +## Setup Debugger +* Unzip debugger zip in data folder + ``` + unzip server/core/target/universal/daffodil-debugger-*.zip -d ~/Library/Application\ Support/dapodil + ``` + +## Installation: Review comment: Remove colon from end of `Installation` ########## File path: README.md ########## @@ -23,14 +23,78 @@ 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. Review comment: The debug rework PR has been merged, which changed dapodil to daffodil-dap. Makes sense to update this readme PR now. I thin much of this section changes since it's mostly automated now? ########## File path: README.md ########## @@ -21,14 +21,59 @@ 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) -## Installation +## Download Review comment: I think something somewhere needs to make it clear that either you download the .vsix file or you build the .vsix file from scratch. Right, reading this as a beginner, it seems like you must first download the .vsix file, and then build sometime. In fact, I wonder if we even need this download section? Once we have releases and a webpage, that should all make it pretty obvious where to download prebuilt releases. Maybe this readme should really just be about how to build from scratch? -- 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]
