Skip to content

Commit

Permalink
Update Gems and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fpigerre committed Dec 21, 2016
1 parent adfba4d commit 8f4986d
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
7 changes: 2 additions & 5 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
source 'https://rubygems.org'

# Freeze to GitHub Pages versions:
# https://pages.github.com/versions/
gem 'github-pages', '~> 75'
gem 'jekyll', '~> 3.0.4'
gem 'kramdown', '~> 1.10.0'
# Dependencies are bundled with the github-pages gem
gem 'github-pages', '112', group: :jekyll_plugins

group :test do
gem 'fastimage'
Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,19 @@ If you'd like to contribute, read the entire guidelines here in

## Running Locally

TwoFactorAuth.org is built on [Jekyll](https://jekyllrb.com/). In order to run Jekyll, it is necessary to install Ruby with RubyGems.
TwoFactorAuth.org is built upon [Jekyll](https://jekyllrb.com/), using the [github-pages](https://github.com/github/pages-gem) gem.
In order to run the site locally, it is necessary to install bundler, install all dependencies, and then use Jekyll to serve
the site. If the `gem` command is not available to you, 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
gem install bundler
cd ~/twofactorauth
bundle install
jekyll serve
```

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

## License

Expand Down

0 comments on commit 8f4986d

Please sign in to comment.