Update readme for typescript changes (#36)
* Update readme for typescript changes * Fix npm run test to npm test
This commit is contained in:
Родитель
e45b1a8691
Коммит
f3e4f2982c
12
README.md
12
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.
|
||||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
|
|
Загрузка…
Ссылка в новой задаче