Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

RVM website and documentation

branch: master

This branch is 0 commits ahead and 0 commits behind master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.rdoc

Welcome to the RVM Site Documentation

You can see the documentation live online at rvm.beginrescueend.com/.

Get the Site Running Locally

If you're going to help you'll first need to get the site running locally. Start by forking the repository and cloning the fork.

Requirements

The site requires that you have at least ruby 1.9.2-p136 running in your environment. (Although you can manually use something else, this is what is setup in the .rvmrc file currently.)

You can do this with RVM by typing the following at the command line:

rvm install 1.9.2

rvm-site requires a few gems that can be found in rvm-site.gems, including:

Compass
http://compass-style.org/

HAML (SASS is bundled with this Gem)
http://haml-lang.com/
http://sass-lang.com/

Nanoc3
http://nanoc.stoneship.org/

Rack
http://guides.rubyonrails.org/rails_on_rack.html

Mime-type
http://rubyforge.org/projects/mime-types/

To install the gemset file, use

rvm gemset import rvm-site.gems

Getting it Running

If you are in RVM and have 1.9.2 already running, simply clone this repository and cd to the directory. The project .rvmrc will be loaded and you can open in your editor and start hacking away.

If you would like to view the changes locally as you hack, You can use Nanoc's AutoCompile feature:

nanoc3 aco

To view the images in your browser, first make sure the public folder exists, then copy the images folder to the public folder:

cp -R content/assets/images public

Update Submission

Once you are satisfied with your changes to the documentation push it back to your github fork and initiate a pull request.

Thanks

Thanks for taking the time to work on RVM.

Something went wrong with that request. Please try again.