Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
source 'https://rubygems.org'
gem 'github-pages'

require 'rbconfig'
gem 'wdm', '~> 0.1.0' if RbConfig::CONFIG['target_os'] =~ /mswin|mingw/i
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ Feel free to fork and make a pull request.

You can view your changes locally by installing [jekyll](https://help.github.com/articles/using-jekyll-with-pages).

In ubuntu 14.04:
Installing Jekyll in Ubuntu 14.04
---

sudo apt-get install git ruby1.9.1 ruby1.9.1-dev nodejs
sudo gem install bundle
Expand All @@ -18,6 +19,26 @@ In ubuntu 14.04:
www-browser http://localhost:4000 &
# work, work, work

Installing Jekyll in Windows
---

- Follow the instructions in step 1 [here](http://jekyll-windows.juthilo.com/1-ruby-and-devkit/) (Installing Ruby and the Ruby DevKit).

Then run:

gem install jekyll

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we really need to install jekyll here? shouldn't it get installed automatically by bundle as a dependency of github-pages

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That didn't seem to be working, although I can't confirm that right now. In both these cases I ran in to problems where things wouldn't install correctly. If I just installed the wdm gem and didn't add it in the gemfile, it exploded and didn't work; same thing if I just installed the gem. I guess I can delete these for now, and I can run some more tests from start-to-finish when I get a chance to make sure it works.

gem install wdm

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same thing here. shouldn't this get installed automatically because you added it to Gemfile

gem install bundle
git clone https://github.com/<user>/ev3dev.github.io
cd ev3dev.github.io
bundle install
bundle exec jekyll serve --watch

Now you should be able to visit your page at: [http://localhost:4000](http://localhost:4000). It should auto-update when you change the source files, so all you have to do is refresh your browser.

Previewing Your Changes Online
---

Alternately, when forking, you can create a new branch called `gh-pages`, then your

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternately doesn't help the flow now that this has its own section. we can delete it.

changes can be viewed as `http://<user>.github.io/ev3dev.github.io`. When you do this
though, GitHub will send you lots of email like this, which you should ignore.
Expand Down