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

Commit 6b3378e

Browse files
author
steelbrain
committed
📝 Cleanup README
1 parent e2f947f commit 6b3378e

File tree

1 file changed

+4
-21
lines changed

1 file changed

+4
-21
lines changed

README.md

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,20 @@
11
linter-lua
22
===========
33

4-
> luac — The luac program parses lua files. It can be used for detecting errors in lua code. See [http://www.lua.org/manual/4.0/luac.html](http://www.lua.org/manual/4.0/luac.html) for more informations about luac.
5-
6-
This package will lint your `.lua` opened files in Atom through luac or [luajit](http://luajit.org/running.html). **It will lint on edit and/or save**, so you'll see instantly if your code has errors.
4+
linter-lua package will lint your `.lua` opened files in Atom through luac or [luajit](http://luajit.org/running.html). **It will lint on edit and/or save**, so you'll see instantly if your code has errors.
75

86
Due to the way that luac works it will only notify you of the first error found in the file.
97

10-
## Linter Installation
8+
#### Linter Installation
119
Before using this package, you must ensure that `luac` or `luajit` is installed on your system.
1210

13-
## Installation
11+
#### Installation
1412

1513
* `$ apm install linter` (if you don't have [AtomLinter/Linter](https://github.com/AtomLinter/Linter) installed).
1614
* `$ apm install linter-lua`
1715

18-
## Configuration
16+
#### Configuration
1917

2018
Atom -> Preferences... -> Packages -> Linter lua -> Settings:
2119

2220
* **Executable** Path to your `luac` or `luajit` executable.
23-
24-
## Other available linters
25-
- [linter-luacheck](https://atom.io/packages/linter-luacheck), for lua using `luacheck`
26-
- [linter-php](https://atom.io/packages/linter-php), for PHP using `php -l`
27-
- [linter-phpcs](https://atom.io/packages/linter-phpcs) - Linter plugin for PHP, using phpcs.
28-
- [linter-phpmd](https://atom.io/packages/linter-phpmd) - Linter plugin for PHP, using phpmd.
29-
- [linter-jshint](https://atom.io/packages/linter-jshint) - Linter plugin for JavaScript, using jshint.
30-
- [linter-scss-lint](https://atom.io/packages/linter-scss-lint) - Sass Linter plugin for SCSS, using scss-lint.
31-
- [linter-coffeelint](https://atom.io/packages/linter-coffeelint) Linter plugin for CoffeeScript, using coffeelint.
32-
- [linter-csslint](https://atom.io/packages/linter-csslint) Linter plugin for CSS, using csslint.
33-
- [linter-rubocop](https://atom.io/packages/linter-rubocop) - Linter plugin for Ruby, using rubocop.
34-
- [linter-tslint](https://atom.io/packages/linter-tslint) Linter plugin for TypeScript, using tslint.
35-
36-
## Donation
37-
[![Share the love!](https://chewbacco-stuff.s3.amazonaws.com/donate.png)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=KXUYS4ARNHCN8)

0 commit comments

Comments
 (0)