From afb27b9be31fe003dc9aa163a97e60205e2e4cff Mon Sep 17 00:00:00 2001 From: "Jill M. Nolan" Date: Fri, 30 Oct 2020 00:00:24 -0400 Subject: [PATCH] updated README and package.json --- README.md | 75 +++++++++++++++++++++++++++++++++++++++++++++------- package.json | 4 +-- 2 files changed, 68 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a96d475..ca0c183 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,79 @@ -# README +# COBOL Essentials, a Visual Studio Code extension package for Mainframe Development + +## Introduction + +Are you tired of reinstalling extensions on each of your computer(s)? How about when you have to reset computer entirely? Or, how about you're an instructor, a hobbyist, or just "getting your feet wet" in the fine craft of Java programming who does not know which extension(s) to select to get the job done both efficiently and effectively. Regardless, please do not waste time and energy on something so tedious as a process of installing extensions. Extensions are, in a word, awesome! Their premise is to extend the features and functionality of **Visual Studio Code**. ## What extensions will I get by downloading this extension pack? -* [**Zowe Explorer**](https://marketplace.visualstudio.com/items?itemName=Zowe.vscode-extension-for-zowe): A **VSCode plugin**, powered by **Zowe CLI**, that streamlines interaction with mainframe data sets, USS files, and jobs. The Zowe Explorer extension modernizes the way developers and system administrators interact with z/OS mainframes by: +Glad, that you've asked! Please find the supervening extensions. Of course, I always love to hear your suggestions to improve this extension package. To do so, please create a new issue in the [**Issues Section**](https://github.com/jillmnolan/cobol-essentials/issues). After all, the ultimate goal for this extension pack is convenience at the click of one button. + +### Recommended Extensions for COBOL Programming + +* [**IBM Z Open Editor**](https://marketplace.visualstudio.com/items?itemName=IBM.zopeneditor): A **VSCode plugin** that provides **COBOL**, **PL/I**, **HLASM language servers**, and **IBM Z development** tool. + +* [**Zowe Explorer**](https://marketplace.visualstudio.com/items?itemName=Zowe.vscode-extension-for-zowe): A **VSCode plugin**, powered by **Zowe CLI**, that streamlines interaction with **mainframe data sets**, **USS files**, and **jobs**. The **Zowe Explorer** extension modernizes the way **developers** and **system administrators** interact with **z/OS mainframes** by: - * Enabling you to create, modify, rename, copy, and upload data sets directly to a z/OS mainframe. + * Enabling you to create, modify, rename, copy, and upload data sets directly to a **z/OS mainframe**. - * Enabling you to create, modify, rename, and upload USS files directly to a z/OS mainframe. + * Enabling you to create, modify, rename, and upload **USS files** directly to a **z/OS mainframe**. - * Providing a more streamlined way to access data sets, uss files and jobs. + * Providing a more streamlined way to access **data sets**, **uss files**, and **jobs**. - * Letting you create, edit, and delete Zowe CLI zosmf compatible profiles. + * Letting you create, edit, and delete **Zowe CLI _zosmf_ compatible profiles**. - * Letting you use the Secure Credential Store plug-in to store your credentials securely in the settings. + * Letting you use the **Secure Credential Store** plugin to store your credentials securely in the settings. -* [**IBM Z Open Editor**](https://marketplace.visualstudio.com/items?itemName=IBM.zopeneditor): A **VSCode plugin** that provides **COBOL**, **PL/I**, **HLASM language servers**, and **IBM Z development** tool. +## Visual Studio Code Tips and Tricks + +* If you wish to use **variables subsitution**, please puruse the [**Visual Studio Code Variables Reference**](https://code.visualstudio.com/docs/editor/variables-reference). + +* If you wish to use **keyboard shortcuts**, please select the weblink to view shortcuts relevant to your operating system: + + * [**Linux**](https://code.visualstudio.com/shortcuts/keyboard-shortcuts-linux.pdf): Link contains PDF. + + * [**macOS**](https://code.visualstudio.com/shortcuts/keyboard-shortcuts-macos.pdf): Link contains PDF. + + * [**Windows**](https://code.visualstudio.com/shortcuts/keyboard-shortcuts-windows.pdf): Link contains PDF. + +* If you wish to use **key bindings**, please puruse the [**Visual Studio Code Key Bindings**](https://code.visualstudio.com/docs/getstarted/keybindings) + + * [**Optional Keymap Extensions**](https://marketplace.visualstudio.com/search?target=VSCode&category=Keymaps&sortBy=Relevance): I recommend the specific keybinding extension that meets your use case through Microsoft, whenever possible. :) + +* Please puruse the [**Visual Studio Code Tips and Tricks**](https://code.visualstudio.com/docs/getstarted/tips-and-tricks) to make your experience a little bit more enjoyable. + +## Note + +It is my pledge to update this Extension Package with updated extension(s) as needed to perform the job efficiently and effectively. Likewise, the Extensions list will be categorized accordingly and more detailed information regarding plugins will be incorporated in the near future. I will certainly be on the lookup for some helpful **COBOL**, **JCL**, and **DB/2** hints and tips to make your experience enjoyable. Cheers! :) + +## Recommended Video Tutorials + +* [**Visual Studio Code Crash Course**](https://www.youtube.com/watch?v=WPqXP_kLzpo): Courtesy of FreeCodeCamp.org YouTube channel (1:32:34). + +**_Please let me know if you know any other FREE COBOL, JCL, or DB/2 resources that might benefit others by creating a new issue in the [Issues Section](https://github.com/jillmnolan/cobol-essentials/issues)_.** + +## Attribution + +Thank you for all the developers that built these above referenced extensions. My genuine appreciation for your hard work and dedication to the developer community. :) + +## Visual Studio Code Extension Packs + +* [**COBOL Essentials**](https://marketplace.visualstudio.com/items?itemName=JillMNolan.cobol-essentials): This Visual Studio Code Extension Pack is what you are currently seeing. :) + +* [**Java Essentials**](https://marketplace.visualstudio.com/items?itemName=JillMNolan.java-essentials): A Visual Studio Code extension pack for Java development. + +* [**.NET Core Essentials**](https://marketplace.visualstudio.com/items?itemName=JillMNolan.dotnet-core-essentials): A Visual Studio Code extension pack for .NET Core development, with special provisions for Azure Cloud development through official Microsoft extensions. + +* [**PHP Development Essentials**](https://marketplace.visualstudio.com/items?itemName=JillMNolan.php-development-essentials): A Visual Studio Code extension pack that serves as the comprehensive version of Web Development Essentials pack, which, unlike Web Development Essentials, does not have Angular or React extensions. + +* [**Python Essentials**](https://marketplace.visualstudio.com/items?itemName=JillMNolan.python-essentials): A Visual Studio Code extension pack for Python development. + +* [**Web Development Essentials**](https://marketplace.visualstudio.com/items?itemName=JillMNolan.web-development-essentials-pack): A Visual Studio Code extension pack that serves as the condensed version of the PHP Development Essentials pack for Visual Studio Code, whose main premise is centered around JavaScript ecosystem. +## Disclaimer +**Please be advised that this is an "off-the-clock" passion project, whose intent is to be utilized by anyone (including my colleagues) who will derive benefit from this one-click installation of popular extensions that I felt was a relevant theme to this Extension Pack.** +## Singing Off -**Enjoy!** +**Please enjoy! Cheers!** diff --git a/package.json b/package.json index 24eb95f..87d3a03 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,8 @@ { "name": "cobol-essentials", "displayName": "COBOL Essentials", - "description": "COBOL Essentials for Visual Studio Code", - "version": "0.0.1", + "description": "COBOL Essentials Extension Pack for Visual Studio Code", + "version": "0.0.2", "icon": "icon.png", "publisher": "JillMNolan", "engines": {