Skip to content
This repository has been archived by the owner on Jul 8, 2019. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Pablissimo committed Mar 29, 2017
1 parent c37d792 commit 11fc92f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions samples/basic-setup/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
#Basic setup example
# Basic setup example
This sample project can be analysed by SonarQube to demonstrate:

* Linting information from ```tslint```, configured via a ```tslint.json``` file
* Code coverage metrics from an LCOV file

You can see a live example of the results of analysing this project at [https://sonar.pablissimo.com](https://sonar.pablissimo.com/dashboard?id=com.pablissimo.sonar%3Abasic-setup).

##Building and analysing
## Building and analysing

* Run ```npm install``` from the cloned repo folder
* Run ```npm test``` to regenerate code coverage information
Expand All @@ -16,7 +16,7 @@ To analyse with SonarQube just run ```sonar-scanner -X``` from the cloned repo f

* The -X flag will give us diagnostic information during the run, so you can see what the plugin is up to

##Breaking down the sonar-project.properties file
## Breaking down the sonar-project.properties file

The sample has a ```sonar-project.properties``` file that controls how the analysis gets run. We haven't specified anything here that isn't its default or automatically detected - these are explained under the table.

Expand Down

0 comments on commit 11fc92f

Please sign in to comment.