Skip to content

Installing on Windows

Luca Palonca edited this page May 23, 2022 · 25 revisions

Requirements

Note: This guide is not for cygwin, and assumes you have installed Ruby via the one-click installer. These steps are known to work with 32/64 bit versions of Windows 7, 8, 8.1 and 10 (tech-preview).

Before you start

Check if you are running a 32-bit or 64-bit Windows install. The Ruby one-click-installer and Ruby Devkit come in both flavours. With the wrong version, you will have issues installing lolcommits gem dependencies that require native compiling.

  • With 'Start' screen open, just type "system' and select 'System' in the 'Search result panel'
  • Listed under 'System type' it will display 32 or 64 bit

Git

First, please ensure you have git installed and working. The git command should be available in your Windows command prompt. Type git --version to check the install worked.

ImageMagick

  1. Download ImageMagick from here e.g. ImageMagick-6.8.0-3-Q16-windows-dll.exe. NOTE: At the time of writing this older version of ImageMagick is known to work with the MiniMagick gem on Windows. Ymmv with newer or different versions of ImageMagick and the MiniMagick gem.
  2. When prompted make sure Add application directory to your system path and Install legacy utilities is checked before proceeding.
  3. Close and reopen your command prompt to reload your PATH variables.
  4. Run convert -v to check the install worked.

Ruby

There are many ways to install Ruby on Windows. To get up and running quickly we recommend the one-click installer. Make sure you choose a Ruby version that has a compatible Ruby Development Kit available (see below).

Download and run the installer following the prompts to complete the installation. When prompted make sure Add Ruby executables to your PATH is checked before proceeding. Close, then re-open your command prompt and type ruby -v to check the install worked.

Ruby Development Kit

After installing Ruby, you'll need the Ruby Development Kit. This provides extra libraries and modules necessary for installing some Ruby gems with C bindings. We'll need this for some of lolcommits dependencies.

  1. Grab the Ruby Development Kit from here
  2. Unpack it somewhere (e.g. C:\RubyDevKit)
  3. Open a command prompt and cd to this directory
  4. Run ruby dk.rb init to prepare the install
  5. Run ruby dk.rb review to review the install
  6. Run ruby dk.rb install to complete the install

For more information or troubleshooting see https://github.com/oneclick/rubyinstaller/wiki/Development-Kit.

Lolcommits

Woo, that's it! All the prerequisites have been taken care of. Now all you need to do is install lolcommits and enable it in your own git repo.

gem install lolcommits
cd C:\your_repo
lolcommits --enable

Note: For any of steps above, re-opening your command prompt may not refresh your PATH environment variable on some versions of Windows, and a full restart may be required.

If you run into any issues, copy your error and Google around.