Skip to content

Commit

Permalink
fix(docs): improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
uglow committed May 24, 2022
1 parent 85ae257 commit caf5a58
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 16 deletions.
14 changes: 0 additions & 14 deletions DEVELOPERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions src/ptx.js
Original file line number Diff line number Diff line change
Expand Up @@ -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('');
}
Expand Down

0 comments on commit caf5a58

Please sign in to comment.