Skip to content

Commit

Permalink
Merge pull request #4 from LukasRypl/use-docker
Browse files Browse the repository at this point in the history
How to run it inside docker
  • Loading branch information
CoralineAda committed Oct 19, 2017
2 parents 42da87b + 4af745a commit 054fe13
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ This installs the CLI tool.

fuku check path/to/file/my_file.rb

fuku check path/to/directory
# Generates report for all rb files in the given directory

fuku check path/to/file/my_file.rb -f html
# Writes to doc/fuzuzatsu/htm/index.htm

Expand All @@ -39,6 +42,13 @@ This installs the CLI tool.
fuku check path/to/file/my_file.rb -f json
# Writes to doc/fuzuzatsu/json/results.json

### Running as docker image

The following will download the latest docker image, mount the current directory inside the container and run `fuku check -f html .` which generates html report for all ruby files in the current directory.

docker run -v $(pwd):/tmp/fuku --workdir=/tmp/fuku rubygem/fukuzatsu check -f html .


## Contributing

Please note that this project is released with a [Contributor Code of Conduct](http://contributor-covenant.org/version/1/0/0/). By participating in this project you agree to abide by its terms.
Expand Down

0 comments on commit 054fe13

Please sign in to comment.