Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Install Jekyll instructions out of order #411

Open
JacobChrist opened this issue May 25, 2018 · 5 comments
Open

Install Jekyll instructions out of order #411

JacobChrist opened this issue May 25, 2018 · 5 comments
Assignees

Comments

@JacobChrist
Copy link
Member

On the following documentation page: http://chipkit32.github.io/chipKIT-core/docs_template

which is in the repo here:

.../chipKIT-core/docs/docs_template.md

The instructions have you install Jekyll prior to cloning the repo. The install instructions have suggest that Jekyll will "rad" (should be read) the Gemfile from the cloned repo (which is not possible because it has not been cloned yet)

Install Jekyll
To install Jekyll bundle will rad the contents of the Gemfile in the docs directory.

@JacobChrist
Copy link
Member Author

Additional changes / errors. I download GitHub Desktop 1.2.0. To install Jekyll I had to do the additional that is missing from the instructions:

  1. Add the cloned chipKIT-core to the GitHub Desktop.
  2. (optional) Set preferred shell by going to File->Options...->Advanced (tab) then selecting Shell from the drop down.
  3. Open the shell by going to Repository->Open in "selected shell"

@JacobChrist
Copy link
Member Author

After trying all three shells the instructions to install Jekyll did not work. Specifically the "bundle install" command fails.

@EmbeddedMan
Copy link
Member

I'm attempting to contact David Powell, who I believe wrote these instructions, so we can assign this issue to him in GH to fix. Thanks for testing it out Jacob.

@JacobChrist
Copy link
Member Author

The "bundle install" command assumes Ruby is installed on your computer. This maybe the only step that is missing from the instructions. If I have time to verify this I'll update the instructions and make a pull request.

@JacobChrist
Copy link
Member Author

I got Jekyll to work on my Windows 10 computer by doing the following:

  1. Installed ruby from this site: https://rubyinstaller.org/downloads/
  2. After ruby was installed I had to run the "gem install bundler" command to get the bundler.
  3. I was able to now run the "bundle install" command in the docs directory.
  4. Run "bundle exec jekyll serve"
  5. Open the web site "localhost:4000"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants