[daffodil-vscode] branch main updated: Add details to README.md:

[jw...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

jw3 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/daffodil-vscode.git


The following commit(s) were added to refs/heads/main by this push:
     new 597052b  Add details to README.md:
597052b is described below

commit 597052b2eb43a585a141eaf3fb1ed758dd82d959
Author: Shane Dell <sh...@gmail.com>
AuthorDate: Mon Oct 18 10:58:42 2021 -0400

    Add details to README.md:
    
    - Add instructions of how to run a full build of the extension and debug backend.
    - Add instructions on the running of the debug server.
    - Update Installation instructions.
    - Add Getting Help and License section (based on Daffodil repo).
    
    Closes #23
---
 README.md    | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++---
 package.json |  4 +++-
 2 files changed, 68 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index ef73fd9..4aeda44 100644
--- a/README.md
+++ b/README.md
@@ -21,14 +21,76 @@
 
 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 running extension via VSCode without VSIX but a `yarn install` will be required**:exclamation:
+
+Run full build
+  ```bash
+  yarn build
+  ```
+
+* This command performs the following tasks:
+  * Create sbt zip package
+  * Install dependencies
+  * Compiles Extension
+  * Packages Extension
+  * Creates Files
+    ```
+    server/core/target/universal/daffodil-debugger-*.zip
+    daffodil-debugger-*.vsix
+    ```
+
+## Running Debug Server
+
+The debug server will automatically be ran by the extension unless `useExistingServer` is to set to `true` inside of `.vscode/launch.json`
+
+If you wish to ran the debug server manually the scripts to do so are at the following locations:
+* Debugging through VSCode with or without VSIX:
+  * Linux = `/home/USERNAME/.local/share/daffodil-dap`
+  * Mac = `/Users/USERNAME/Library/Application\ Support/daffodil-dap`
+  * Windows = `C:\\Users\\USERNAME\\AppData\\Roaming\\daffodil-dap`
+  
+
 
 ## Installation
 
-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>`.
+Once you have either downloaded the VSIX file or created it you can now install it. There are two options to do this:
 
+* Via "Extensions: Install from VSIX" command from within VS Code.
+  * Open the Command Palette with Shift-Command-P (Mac) OR Shift-Ctrl-P (Windows/Linux)
+  * Type `vsix` to bring up the command and pointing it at the `vsix` file
+
+* Via command line
+  ```bash
+  code --install-extension daffodil-debugger-*.vsix
+  ```
 
 ## Usage
 
 Please refer to the Wiki page at https://github.com/apache/daffodil-vscode/wiki
+
+## Getting Help
+
+You can ask questions on the dev@daffodil.apache.org or
+users@daffodil.apache.org mailing lists.  You can report bugs via
+[GitHub Issues].
+
+## License
+
+Apache Daffodil VSCode is licensed under the [Apache License, v2.0].
+
+[Apache License, v2.0]: https://www.apache.org/licenses/LICENSE-2.0
+[GitHub Issues]: https://github.com/apache/daffodil-vscode/issues
diff --git a/package.json b/package.json
index d1e5d36..1edfc3c 100644
--- a/package.json
+++ b/package.json
@@ -33,7 +33,9 @@
     "publish": "vsce publish",
     "package-ext": "webpack --mode production --config ./build/extension.webpack.config.js",
     "pretest": "yarn run compile && yarn run lint",
-    "test": "node node_modules/mocha/bin/_mocha -u tdd --timeout 999999 --colors ./out/tests"
+    "test": "node node_modules/mocha/bin/_mocha -u tdd --timeout 999999 --colors ./out/tests",
+    "sbt": "sbt universal:packageBin",
+    "build": "yarn sbt && yarn install && yarn compile && yarn package"
   },
   "dependencies": {
     "await-notify": "1.0.1",