[openwhisk-vscode-extension] branch master updated: Review and update README instructions (#13)

[mr...@apache.org]

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

mrutkowski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/openwhisk-vscode-extension.git


The following commit(s) were added to refs/heads/master by this push:
     new 62b1f1a  Review and update README instructions (#13)
62b1f1a is described below

commit 62b1f1a9c22508b3bc514e754b9158e37969400f
Author: Kent Tsuenchy <63...@users.noreply.github.com>
AuthorDate: Thu Jun 10 13:17:07 2021 -0400

    Review and update README instructions (#13)
    
    * fix spelling of required_approving_review_count field
    
    * fix use of VSCode, should be VS Code
    
    following format from vsc-extension-quickstart.md
    
    * expand section on debugging extension locally
    
    * add suggested revisions to README
    
    * add note about self signed certificates
---
 .asf.yaml |  2 +-
 README.md | 32 ++++++++++++++++++++++----------
 2 files changed, 23 insertions(+), 11 deletions(-)

diff --git a/.asf.yaml b/.asf.yaml
index 7523e83..ef73490 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -34,7 +34,7 @@ github:
       required_status_checks:
         strict: true
       required_pull_request_reviews:
-        required_appoving_review_count: 1
+        required_approving_review_count: 1
   enabled_merge_buttons:
     merge: false
     squash: true
diff --git a/README.md b/README.md
index e71894e..1bdaccf 100644
--- a/README.md
+++ b/README.md
@@ -17,11 +17,11 @@
 #
 -->
 
-# OpenWhisk VSCode Extension
+# OpenWhisk VS Code Extension
 
-An **openwhisk-vscode-extension** is an open-source VSCode extension for [Apache OpenWhisk](https://openwhisk.apache.org/). It manages the wskdeploy manifest file and makes deployment easy. You can also create and update actions and packages in VSCode.
+An **openwhisk-vscode-extension** is an open-source VS Code extension for [Apache OpenWhisk](https://openwhisk.apache.org/). It manages the wskdeploy manifest file and makes deployment easy. You can also create and update actions and packages in VS Code.
 
-Try creating and editing your action code in the VSCode!
+Try creating and editing your action code in the VS Code!
 
 ## Prerequisites
 
@@ -61,16 +61,28 @@ This extension contributes the following commands to the Command palette.
 
 - `Create a wskdeploy project`: creates a wskdeploy project
 
-## How to debug in your local
+## How to debug in your local environment
 
-```bash
-git clone https://github.com/apache/openwhisk-vscode-extension.git
-code ./openwhisk-vscode-extension # Open openwhisk-vscode-extension in VSCode
-```
+### Requirements
+
+- [vscode](https://code.visualstudio.com/) >= 1.41.0
+- [Node.js](https://nodejs.org/en/download/) >= 12.x
+- Have an OpenWhisk deployment available, which you set up by following this [guide](https://openwhisk.apache.org/documentation.html#pre-requisites) or by using one of the managed OpenWhisk offerings (e.g., from IBM, Adobe or Nimbella). Note, deployments with self signed SSL certificates may not work with this extension.
+
+### Set up
+
+1. Clone the repository:
 
-Press `F5` button(run debug)
+    ```bash
+    git clone https://github.com/apache/openwhisk-vscode-extension.git
+    code ./openwhisk-vscode-extension # Open openwhisk-vscode-extension in VS Code
+    ```
 
-Learn more about debugging [here](https://github.com/apache/openwhisk-vscode-extension/blob/master/vsc-extension-quickstart.md)
+2. In your terminal, execute the command `npm install` to install extension dependencies
+3. In your terminal, execute the command `npm run webpack-dev` to start up the extension builder in watch mode (allows for making changes to files and rebuilding automatically)
+4. Open up the `src/extension.ts` file for editing
+5. In the `src/extension.ts` file press `F5` button to start debugger and select `VS Code Extension Development` if a modal appears at the top of the VS Code window
+6. Interact with the `DEBUG CONSOLE` for real time debugging of the extension and learn more about debugging [here](https://github.com/apache/openwhisk-vscode-extension/blob/master/vsc-extension-quickstart.md)
 
 ## License