Skip to content

Commit

Permalink
Adding license
Browse files Browse the repository at this point in the history
  • Loading branch information
cytopia committed Apr 9, 2018
1 parent 61b45a1 commit 8b1de45
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ before_install:
- sudo apt-get update -qq

# Install
- sudo apt-get install -qq ruby2.1 ruby-switch shellcheck moreutils php5 dos2unix
- sudo apt-get install -qq ruby2.1 ruby-dev ruby-switch shellcheck moreutils php5 dos2unix

# Set ruby version
- sudo ruby-switch --set ruby2.1
Expand Down
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2016 cytopia

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
[![OSX](https://raw.githubusercontent.com/cytopia/icons/master/64x64/osx.png)](https://www.apple.com/osx)



Lot's of tools for git, file and static source code analysis.

**Documentation**
Expand Down Expand Up @@ -60,6 +59,7 @@ All checks have the option to only check by one or more file **extensions**, by
| Regex | [regex-grep](bin/regex-grep) | | `egrep` (`grep -E`) regex version to scan files for an occurance. |
| Regex | [regex-perl](bin/regex-perl) | | `perl` regex version to scan files for an occurance. |


## Learn / validate

All of the above scripts offer the `--dry` option which will only show you the built command without actually executing it:
Expand All @@ -75,6 +75,7 @@ find . -type f -not \( -path "./.git*" -o -path "./.svn*" \) ! -size 0 -print0 |
xargs -0 -P 8 -n1 sh -c 'if [ -f "${1}" ]; then grep --color=always -inHE "if[[:space:]]*\[\[" "$1" || true; fi' --
```


## Fix

Some of the above scripts offer the `--fix` option (see table above), with which you are actually able to fix the problem.
Expand All @@ -96,7 +97,6 @@ In order to give you an idea, have a look at the compiled [Regex Contributions](
Please use pull requests to add useful checks.



## General Usage

* All tools share the same pattern (except `git-ignored`) and can be used with the same command line arguments.
Expand Down Expand Up @@ -129,12 +129,9 @@ Please use pull requests to add useful checks.
--help # Show help
--info # Show version of required binaries
--version # Show tool version

```




## Installation

### Install OSX
Expand All @@ -159,3 +156,10 @@ make install
./configure --prefix=/opt
make install
```


## License

[MIT License](LICENSE.md)

Copyright (c) 2016 [cytopia](https://github.com/cytopia)

0 comments on commit 8b1de45

Please sign in to comment.