Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tknerr/ruby-devpack

A DevPack containing all you need for developing with Ruby on Windows
https://github.com/tknerr/ruby-devpack

Last synced: about 1 month ago
JSON representation

A DevPack containing all you need for developing with Ruby on Windows

Host: GitHub
URL: https://github.com/tknerr/ruby-devpack
Owner: tknerr
License: mit
Created: 2014-05-10T13:38:48.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2015-04-04T11:35:40.000Z (over 9 years ago)
Last Synced: 2023-03-23T00:22:27.058Z (almost 2 years ago)
Language: Ruby
Homepage: https://github.com/tknerr/ruby-devpack
Size: 668 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

README

# Ruby DevPack

A [DevPack](http://blog.tknerr.de/blog/2014/10/09/devpack-philosophy-aka-works-on-your-machine/) with all you need for developing with Ruby on Windows, shrink-wrapped in a portable package.

No installation, just [extract and get going](#installation-and-usage)!

![Ruby DevPack Screenshot](https://raw.github.com/tknerr/ruby-devpack/master/doc/ruby_devpack_screenshot.png)

## Installation and Usage

Using the Ruby DevPack is fairly simple. There is nothing to install, just unpack and go:

1. Grab the latest `ruby-devpack-.7z` package from the [releases page](https://github.com/tknerr/ruby-devpack/releases) and unpack it
1. Mount the devpack to the `X:\` drive by double-clicking the `mount-drive.bat` file
1. Click `X:\Launch ConEmu.lnk` to open a command prompt (also runs `X:\set-env.bat` to set up the environment)
1. Start hacking!

## What's included?

### Main Tools

The main tools for hacking Ruby:

* [Ruby](http://rubyinstaller.org/downloads/) 2.2.1
* [DevKit](http://rubyinstaller.org/add-ons/devkit/) 4.7.2

### Supporting Tools

Useful additions for a better cooking experience:

* [ConEmu](https://code.google.com/p/conemu-maximus5/) - a better Windows console with colours, tabs, etc...
* [SublimeText2](http://www.sublimetext.com/) - a better editor (trial version)
* [PortableGit](https://code.google.com/p/msysgit/) - git client for Windows (preconfigured with [kdiff3](http://kdiff3.sourceforge.net/) as diff/merge tool)
* [putty](http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html) - the SSH client for Windows
* [clink](http://mridgers.github.io/clink/) - command completion and Bash-like line editing for Windows

### Environmental Changes

The following changes are applied to your environment by running `X:\set-env.bat`:

* Constraining as much as possible to the `X:\` drive:
* `%HOME%` points to `X:\home`
* `%PATH%` is preprended with the bin dirs of the tools in `X:\tools\`
* Fixing annoyances:
* `set ANSICON=true` to get coloured console output
* `set RI=--format bs` to restore plain (i.e. non-ansi colored) output for ri
* `set SSL_CERT_FILE=X:\home\cacert.pem` pointing to recent CA certs avoiding Ruby SSL errors

### Aliases

Registered doskey aliases:

* run `be ` for `bundle exec `
* run `vi ` for `sublime_text `

## Building from Source (Development)

As a prerequisite for building the Ruby DevPack you need a Ruby environment (yes chicken-egg ;-)) and 7zip installed in `C:\Program Files\7-Zip\7z.exe`.

### Building the Ruby DevPack

To build the Ruby DevPack (make sure you don't have spaces in the path):
```
$ gem install bundler
$ bundle install
$ rake build
```

This might take a while (you can go fetch a coffee). It will download the external dependencies, install the tools and prepare everything else we need into the `target/build` directory. Finally it runs the `spec/integration` examples to ensure everything is properly installed.

### Packaging

Finally, if all the tests pass you can create a portable zip package:
```
$ rake package
```

This will and finally package everything in the `target/build` directory into `target/ruby-devpack-.7z`.

### Changing the Mount Drive Letter

By default the Ruby DevPack will be mounted to the `X:\` drive. If you need to change it you only have to update the references in these two files:

* `mount-drive.cmd`
* `unmount-drive.cmd`

## Acknowledgements & Licensing

This Ruby DevPack bundles lots of awesome Open Source software. The copyright owners of this software are mentioned here. For a full-text version of the licenses mentioned above please have a look in the `tools` directory where the respective software is installed.

* ConEmu - Copyright (c) 2006-2008 Zoin , 2009-2013 Maximus5 (BSD 3-Clause license)
* clink - Copyright (c) 2012-2014 Martin Ridgers (MIT license), 1994–2012 Lua.org, PUC-Rio (GPLv3)
* PortableGit - by msysGit team (GPLv2 license)
* RubyInstaller - Copyright (c), 2007-2014 RubyInstaller Team (BSD 3-Clause license)
* DevKit - Copyright (c), 2007-2014 RubyInstaller Team (BSD 3-Clause license)
* kdiff3 - Copyright (c) 2002-2012 Joachim Eibl (GPLv2 license)
* putty - Copyright (c) 1997-2014 Simon Tatham (MIT license)

It also includes an evaluation copy of the awesome [Sublime Text 2](http://www.sublimetext.com/) editor. Please use it for evaluation purposes only (no commercial usage) or [buy a license](http://www.sublimetext.com/buy) if you like it!

The Ruby DevPack itself is published under the MIT license. It is not "derivative work" but rather ["mere aggregation"](https://www.gnu.org/licenses/gpl-faq.html#MereAggregation) of other software and thus does not need to be licensed under GPL itself.