README.rdoc in rconf-0.10.1 vs README.rdoc in rconf-1.0.0

- old
+ new

@@ -5,11 +5,11 @@ == INTRODUCTION As RightScale systems evolve, developers are faced with having to maintain a quickly growing list of applications. Each application requires different tools for development and for deployment. Tools may include different versions of -ruby, rubygems, bundler etc. Being able to setup an environment appropriately +ruby, bundler etc. Being able to setup an environment appropriately for each application is becoming increasingly complex and switching from one application to another for development in particular is quickly becoming close to impossible. rconf aims at addressing some of these difficulties by providing a uniform @@ -17,13 +17,14 @@ declaratively specify the tools they depend on various platforms (linux, darwin and potentially windows). rconf uses a DSL close to Chef recipes for defining an application configuration. Each application must be equipped with a definition that must reside at the top -level directory of the application and use the '.rconf' file extension. When run -for the first time rconf sets up a .rvmrc file which gets invoked and sets up -the environment each time the application directory gets 'cd-ed' into. +level directory of the application and use the '.rconf' file extension. +rconf must be invoked manually using the 'rconf' command line utility to setup +the environment using the rconf file in the current folder or the one contained +in a parent folder (the closest parent to the current directory will get used). Internally rconf relies on 'configurators' to configure the machine appropriately. There is one configurator per tool that needs configuration. Each configurator is dynamically instantiated by rconf as it reads the application configuration file. This makes for an extensible system where new @@ -45,55 +46,18 @@ - Win32API gem == INSTALLING -There are two installation cases - -a) you've already got a working install of RVM -b) blank system - -=== a) Installing when RVM is already present - It should be as simple as: - gem install rconf +> gem install rconf and then moving to your repository and running: - rconf +> rconf to let rconf prepare your environment for the repository. - -=== b) Installing on a blank system - -If your system fits the requirements listed above, installing rconf will -require you to make a system install of rconf: - - sudo gem install rconf - -then you can go to your repository and run - - rconf - -If you do not have a x.rconf equipped directory and you want rconf to install rvm for -you, you can create a file named dummy.rconf containing: - - ruby do - version 'ruby-1.9.2-p290' - rubygems '1.8.10' - end - -and then run rconf against it: - - rconf dummy.rconf - -=== rconf and existing .rvmrc files - -If you have pre-existing .rvmrc files and they don't play well with your -.rconf configuration file, don't hesitate to delete them and run rconf. -rconf will create a new, working, .rvmrc. - == WRITING RCONF CONFIGURATION FILES rconf uses a ruby DSL for configuration files (.rconf). Each configurator is associated with a keyword. The configuration for a given configurator then