From f3e4f2982c7196400d6e4c87b25f049334394f0e Mon Sep 17 00:00:00 2001 From: Ethan Arrowood Date: Wed, 26 Sep 2018 11:39:14 -0400 Subject: [PATCH] Update readme for typescript changes (#36) * Update readme for typescript changes * Fix npm run test to npm test --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 24ad490..3b83baa 100644 --- a/README.md +++ b/README.md @@ -134,13 +134,13 @@ npm install Now you're ready to begin contributing! +### Compiling + +This project uses Typescript. In order to run the code it must first be compiled using `npm run compile`. This command will first remove any existing compiled files by running `rimraf dist/`. It then compiles all javascript files contained within the `src` directory following the configurtion in `tsconfig.json`. + ### Testing -To run the tests for this project, first ensure you've installed the [requirements](#development-requirements). Then use npm to run the tests locally: - -``` -npm test -``` +To run the tests for this project, first ensure you've installed the [requirements](#development-requirements). Next, compile the project using `npm run compile`. Following a successful compile, you can run `npm test`. The test script will also run `tslint` on the project. Note that this command is meant to be run from the project directory. That is, the folder that you cloned the project into (likey `platform-chaos`). @@ -180,4 +180,4 @@ Note that once you've [submitted a pull request](https://github.com/Azure/platfo This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or -contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. \ No newline at end of file +contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.