From caf5a58fe6df581deea11e732efd4aea21254c5e Mon Sep 17 00:00:00 2001 From: Brett Uglow Date: Tue, 24 May 2022 10:58:54 +1000 Subject: [PATCH] fix(docs): improve docs --- DEVELOPERS.md | 14 -------------- src/ptx.js | 4 ++-- 2 files changed, 2 insertions(+), 16 deletions(-) diff --git a/DEVELOPERS.md b/DEVELOPERS.md index 2d08111..168d551 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -29,7 +29,6 @@ following products on your development machine: The project is organised into the following folder structure: - `/` - Project-level configuration (linting rules, CI, docs, license) -- `public/` - Files that are deployed to GitHub pages (web-content). The generated JS & CSS files are copied here. - `src/` - The source code and test specifications ## Installing @@ -39,19 +38,6 @@ The project is organised into the following folder structure: npm install ``` -## Running Tests - -```shell -# Run unit tests -npm test - -# Run unit tests in watch mode -npm run test:watch - -# Run tests and see the coverage report -npm run test:reportlist -``` - ## Formatting your source code This project uses [eslint](https://eslint.org) and [prettier](https://prettier.io/) to format the source code. diff --git a/src/ptx.js b/src/ptx.js index 722c23d..44a9642 100755 --- a/src/ptx.js +++ b/src/ptx.js @@ -74,9 +74,9 @@ function showHelp() { console.log('\nwhere:'); console.log(' tuneConfigFile Path to the tune config file, relative to the script'); console.log('\nExample: npx ptx scripts/publishPlanStream.json'); - console.log('\nNote: The PTX_STACK_NAME environment variable must be set to the name of the PowerTune stack'); + console.log('Note: The PTX_STACK_NAME environment variable must be set to the name of the PowerTune stack'); console.log( - '\nReference: https://github.com/alexcasalboni/aws-lambda-power-tuning/blob/master/README-INPUT-OUTPUT.md', + 'Reference: https://github.com/alexcasalboni/aws-lambda-power-tuning/blob/master/README-INPUT-OUTPUT.md', ); console.log(''); }