diff --git a/.vscode/launch.json b/.vscode/launch.json index d406cc3..cbc6367 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -15,7 +15,7 @@ "--timeout", "999999", "--colors", - "${workspaceFolder}/test/" + "${workspaceFolder}/test" ], "internalConsoleOptions": "openOnSessionStart" }, diff --git a/README.md b/README.md index 6401b77..5ed38cd 100644 --- a/README.md +++ b/README.md @@ -1,162 +1,168 @@ -# opspark -A node utility supporting installation and configuration of operation spark projects. - -**Table of Contents** - -- [opspark](#opspark) - - [Prerequisites](#prerequisites) - - [Publishing Projects and Updates to Your Website](#publishing-projects-and-updates-to-your-website) - - [Installation](#installation) - - [Usage](#usage) - - [Initializing Your Portfolio](#initializing-your-portfolio) - - [Installing Projects](#installing-projects) - - [Testing Projects](#testing-projects) - - [Submitting Projects](#submitting-projects) - - [Shelving Projects](#shelving-projects) - - [Uninstalling Projects](#uninstalling-projects) - - [Pair Programming on Projects](#pair-programming-on-projects) - - [Help](#help) - - [For Teachers and Developers](#for-teachers-and-developers) - - [Headstart](#headstart) - - [Keeping Master Files](#keeping-master-files) - -## Prerequisites - -The `opspark` npm utility is designed to work with the Operation Spark website project, which starts with two lessons that you and your students should complete before installing and using the `opspark` npm utility. The two prerequisites lessons are: - -1. First Website: Available here... -2. Portfolio Page: Available here... - -Combined, these two prerequisites website lessons build-out and publish live, a cool website that includes a home page (`index.html`), which links to a portfolio page (`portfolio.html`). - -The portfolio page is designed to automatically list all Operation Spark projects installed using the `opspark` npm utility. - -These subsequent _sub-projects_ are installable through the `opspark` npm utility. After installing the `opspark` npm utility (see instructions below), you will have access to certain commands via the commandline (again, see instructions below), which will allow you to select the project you want to install from a list of all installable projects. - -On selecting a project to install, the project is downloaded and installed in the `projects/projectName` directory in the root directory of your website, and if any bower components are required, they are installed during this process so the student is ready to begin straight away. - -The projects can be games, simple apps, or programmer art - projects intended to illustrate, practice and problem solve in a certain area of software development. - -## Publishing Projects and Updates to Your Website - -Remember that in our First Website lesson, we pushed our changes to our GitHub Pages website by executing the typical `git` workflow commands of: - - git add -A - git commit -m "A commit message describing our changes" - git push - -When updating your website or publishing a completed project to your live website, remember that you'll need to run the same `git` commands. - -## Installation - - npm install -g opspark - -## Usage - -### Initializing Your Portfolio - -If you've completed the portfolio.html lesson (see [Prerequisites](#prerequisites), above), then you'll need to initialize your portfolio by first running the command: - - os init-pf - -Running this command will write a few script tags to the `portfolio.html`, allowing installed projects to appear dynamically as new `
  • ` entries in the `