Skip to content

Commit

Permalink
Add 'running-locally' section to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fpigerre committed Jun 28, 2016
1 parent 56441df commit cc17482
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,19 @@ offer for their customers. This can also serve as an indicator for the effort a
If you'd like to contribute, read the entire guidelines here in
[CONTRIBUTING.md][contrib].

## Running Locally

TwoFactorAuth.org is built on [Jekyll](http:https://jekyllrb.com/). In order to run Jekyll, it is necessary to install Ruby with RubyGems.
Once Ruby and RubyGems are installed and available from the command line, TwoFactorAuth can be setup using the following commands.

```
gem install jekyll
cd ~/twofactorauth
jekyll serve
```

The TwoFactorAuth website should then be running on `http:https://localhost:4000`.

## License

This code is distributed under the MIT license. For more info, read the
Expand Down

0 comments on commit cc17482

Please sign in to comment.