This repository has been archived by the owner on Mar 16, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Yorick Peterse <yorickpeterse@gmail.com>
- Loading branch information
Yorick Peterse
committed
Aug 6, 2012
1 parent
5bd24ba
commit 431cd34
Showing
1 changed file
with
26 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,27 @@ | ||
# README | ||
|
||
Rlint is a linter and static code analysis tool for Ruby inspired by similar | ||
tools such as JSHint. It makes it possible for developers to detect errors such | ||
as undeclared (or unused) variables and the use of non existing constants. | ||
|
||
Currently Rlint is in a very, very early stage of development. There's nothing | ||
more than a half assed parser using Ripper and it will take a while for it to | ||
truly become a proper linter. | ||
|
||
## Requirements | ||
|
||
* Ruby 1.9 or newer | ||
* Ripper (comes bundled with Ruby 1.9) | ||
|
||
## Installation | ||
|
||
Once the Gem has been registered and pushed to Rubygems you should be able to | ||
install it as following: | ||
|
||
$ gem install rlint | ||
|
||
## License | ||
|
||
All source code in this repository is licensed under the MIT license unless | ||
specified otherwise. A copy of this license can be found in the file "LICENSE" | ||
in the root directory of this repository. |