Skip to content
This repository has been archived by the owner on Aug 7, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
park9140 committed Sep 8, 2015
1 parent af6cce5 commit 047e417
Showing 1 changed file with 0 additions and 24 deletions.
24 changes: 0 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,11 @@ This linter plugin for AtomLinter provides an interface to [tslint](https://gith
## Installation
Linter package must be installed in order to use this plugin. If Linter is not installed, please follow the instructions [here](https://github.com/AtomLinter/Linter).

### tslint installation (optional if you wish to use an older version of tslint than the plugin)
Before using this plugin, you must ensure that `tslint` is installed on your system. To install `tslint`, do the following:

1. Install [Node.js](http://nodejs.org) (and [npm](https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager) on Linux).

1. Install `tslint` by typing the following in a terminal:
```
npm install -g tslint
```

1. If you are using `nvm` and `zsh`, ensure that the line to load `nvm` is in `.zshenv` and not `.zshrc`.
1. Set the linter-tslint linter path setting to the location of the installed tslint

**Note:** This plugin requires `tslint` 0.4.8 or later.

Now you can proceed to install the linter-tslint plugin.

### Plugin installation
```
$ apm install linter-tslint
```

## Settings
You can configure linter-tslint by editing ~/.atom/config.cson (choose Open Your Config in Atom menu):
```
'linter-tslint':
'tslintExecutablePath': null #tslint path. run 'which tslint' to find the path
```

## Contributing
If you would like to contribute enhancements or fixes, please do the following:

Expand Down

0 comments on commit 047e417

Please sign in to comment.