README.md in gloc-0.3.1 vs README.md in gloc-0.4.0
- old
+ new
@@ -4,18 +4,18 @@
* it groups files based on their file extension, instead of trying to guess their language and grouping them that way
* it doesn't ignore files just because it doesn't recognise them _(ie. cannot correctly guess their language)_
* in a git repo, it processes `$( git ls-files )` by default
* in a non-git repo, it processes `$( find . -type f)` by default
-* it generates human-friendly, `loc`-alike output
+* it generates human-friendly, `(c)loc`-alike output
* it is Unix pipeline friendly, by design:
* it reads the list of filenames to process from `stdin` if `[ ! -t 0 ]`
* it writes machine-parsable JSON output to `stdout` if `[ ! -t 1 ]`
## Example
-For the popular Ruby on Rails framework, `gloc` generates the following `loc`-alike output:
+For the popular Ruby on Rails framework, `gloc` generates the following `(c)loc`-alike output:
--------------------------------------------------------------------------------
Language Files Lines Blank Comment Code
--------------------------------------------------------------------------------
*.rb 2,149 304,495 47,846 42,651 213,998
@@ -59,10 +59,14 @@
* [cgag/loc](https://github.com/cgag/loc)
* [AlDanial/cloc](https://github.com/AlDanial/cloc)
* [Aaronepower/tokei](https://github.com/Aaronepower/tokei)
* [SLOCCount](http://www.dwheeler.com/sloccount/)
+And it **definitely** isn't:
+
+* [LocMetrics](http://www.locmetrics.com/)
+
## Installation
gem install gloc
## Usage
@@ -93,15 +97,14 @@
gloc -lines # sort by the total number of lines
gloc -blank # sort by the number of blank lines
gloc -comment # sort by the number of comment lines
gloc -code # sort by lines of code (default)
-## Known Issues
+## Known Issues and Possible Enhancements
* identify comment-only lines for a lot more languages
* support more file encodings (not just `UTF-8` and `ISO-8859-1`)
* parse shebang lines for scripts without a file extension
-
* (?) installation via Homebrew
* (?) convert script to Perl for performance
## Development