@cmusei/console-forge 0.9.0 → 0.11.0

package/README.md

@@ -15,9 +15,13 @@ cd console-forge
 npm i
 ```
 
-Since ConsoleForge is all about virtual consoles, you're going to need at least one to test drive it. If you don't have easy access to a Proxmox cluster or some other hypervisor host, you can check out [this repo](https://github.com/x11vnc/x11vnc-desktop) to grab yourself a Docker image that hosts a headless VNC server.
+## Starting a compatible console
 
-**NOTE:** If you have Python installed locally and are a VS Code user, you can use the included VS Code Task "Run X11VNC Desktop" to pull and start the container. Easy-peasy!
+Since ConsoleForge is all about virtual consoles, you're going to need at least one to test drive it. Fortunately, this repo includes a script based on the [x11vnc_desktop](https://hub.docker.com/r/x11vnc/docker-desktop) project that does the job very nicely. If you're on a POSIX-compliant shell (i.e. on Windows, you'll need Git Bash or WSL) and are a VS Code user, you can use the included VS Code Task "Run X11VNC Desktop" to pull and start the container. Easy-peasy! See the [x11vnc_desktop](https://hub.docker.com/r/x11vnc/docker-desktop) project if our script doesn't fit your needs.
+
+**NOTE:** If you have access to a Proxmox cluster or some other hypervisor host, you can use also connect to those consoles! Read on to start up our demo/docs app, and use the appropriate page to connect to your consoles.
+
+## Building and debugging
 
 Once you have a compatible console available, you can build the library...
 
@@ -31,7 +35,7 @@ ng build console-forge --watch
 ng serve console-forge-docs
 ```
 
-Navigate to [http://localhost:4200](http://localhost:4200). If you're running the `X11VNC` container, you should be able to access it via the "With x11VNC (Docker Image)" tab!
+Navigate to [http://localhost:4200](http://localhost:4200). If you're running the `X11VNC` container, you should be able to access it via the "With x11VNC (Docker Image)" tab! If you have some other supported console host, you can use the various tabs in our little demo app to connect to your consoles.
 
 ![X11VNC + ConsoleForge](https://raw.githubusercontent.com/cmu-sei/console-forge/refs/heads/main/projects/console-forge-docs/public/assets/screenshot.png)
 
@@ -122,21 +126,16 @@ If it does, things are a little become slightly complex.
 
 ### Including the HTML Console SDK's assets
 
-We use a lightly modified version of the [VMWare HTML Console SDK](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-sdks-tools/8-0/html-console-sdk-programming-guide.html) to deliver VMWare console support. For convenience, we include that SDK in the library. To include it in your Angular app's scripts, you'll need to update the `"styles"` and `"scripts"` sections of your `angular.json` file to include it. It'll look something like this:
+To use ConsoleForge to connect to VMWare consoles, you'll need a copy of the [VMWare HTML Console SDK](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-sdks-tools/8-0/html-console-sdk-programming-guide.html). For licensing reasons, we don't include this SDK with ConsoleForge. To include it in your Angular app's scripts, you'll need to update the `"styles"` and `"scripts"` sections of your `angular.json` file. Depending where you commit it to your project, it'll look something like this:
 
 ```json
 //snip
-"styles": ["dist/console-forge/vendor/vmware-wmks/css/main-ui.css"],
+"styles": ["path/to/vmware-wmks/css/main-ui.css"],
 // snip
-"scripts": ["node_modules/console-forge/vendor/vmware-wmks/js/wmks.min.js"]
+"scripts": ["path/to/vmware-wmks/js/wmks.min.js"]
 // snip
 ```
 
-We make the following adjustments due to our use case:
-
-- We include only the `main-ui.css` stylesheet in the library
-- We don't include images referenced by this CSS for reasons of distribution complexity
-
 ### jQuery
 
 This SDK also has dependencies on jQuery and jQuery UI, which you'll also need to add to your Angular project. Depending on your use case, you can either do this through a CDN like [code.jquery.com](https://code.jquery.com/jquery-3.7.1.min.js) or via your favorite Node package manager. (Note that the HTML Console SDK's current documentation is not specific about which versions of jQuery/jQuery UI are required.) Assuming you're able to install and correctly configure the inclusion of these three dependencies, VMWare consoles in ConsoleForge should work as expected. Having trouble? [Drop as an issue and let us know.](https://github.com/cmu-sei/console-forge/issues)