From a17e641b26453c79f57057f29f4329170e661a80 Mon Sep 17 00:00:00 2001 From: dathompson Date: Fri, 6 Jan 2012 08:44:09 -0800 Subject: [PATCH 1/6] -f --- README.md | 57 ++++++++++++++++++++++++++----------------------------- 1 file changed, 27 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index d8c1acd..9520283 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # RailsInstaller -Rails development environment installer for Windows +Rails development environment installer for Windows. ## Overview @@ -14,20 +14,20 @@ RailsInstaller project code repository is located on GitHub and is bootstrapped, built and packaged via rake tasks. 1. Download and install the latest - [RailsInstaller](http://railsinstaller.org/) + [RailsInstaller](http://railsinstaller.org/). 1. Download and install latest [Inno Setup Quick Start Pack](http://www.jrsoftware.org/isdl.php#qsp), - ensure iscc.exe is in your PATH + ensure iscc.exe is in your PATH. 1. [Fork](http://help.github.com/fork-a-repo/) the [RailsInstaller project on github](https://github.com/railsinstaller/railsinstaller-windows.git) - into your own github account + into your own github account. 1. Open the RailsInstaller Command prompt from the start menu RailsInstaller group and change directories to where you like to keep your projects. -1. Clone your fork of the project +1. Clone your fork of the project. > git clone git@github.com:{{your github user name}}/railsinstaller-windows @@ -42,47 +42,45 @@ built and packaged via rake tasks. > git checkout -b mybranchname -1. Bootstrap the project, from the project root run +1. Bootstrap the project. From the project root run: > rake bootstrap -1. Implement your new feature / fix your bug in the railsinstaller project code. - Configuration of the packages are to be included are found in the - config/railsinstaller.yml file. Building of the installer into the stage path - for packaging happens from the Ruby code in the lib/ directory, starting from - the file lib/railsinstaller/actions.rb. Methods called from actions - file are implemented in lib/railsinstaller/methods.rb. In order to kick off a - build into the stage/ directory run the following rake command. +1. Implement your new feature and/or fix your bug in your newly forked Railsinstaller project code. -1. Next build all components on the stage + * The configuration file for specifying required packages can be found at + config/railsinstaller.yml file. - > rake build + * Building of the installer into the stage path for packaging is implemented by the Ruby + code in the lib/ directory, starting with the file lib/railsinstaller/actions.rb. + + * Methods called by the actions file are implemented by lib/railsinstaller/methods.rb. -1. We are now ready to package the installer for testing/distribution. - Packaging of the installer from the stage path into an executable can be done - via the following rake command. This creates the executable (.exe) - package file in the pkg/ directory from the files staged during the - build process in the stage/ directory. +1. Next build all components onto the stage (into the stage/ directory). - > rake package + > rake build -1. Use Inno Setup to package RailsInstaller (NOTE that You can run the package - task with --trace for debugging output if the package fails to build or if - you simply want to see what is being done as it is done). +1. We are now ready to use Inno Setup to package the installer into an executable (.exe) for testing/distribution. > rake package -1. Once you have verified your Push your feature branch up to GitHub + * This creates the executable (.exe) package file in the pkg/ directory from the files staged + during the build process in the stage/ directory. + + * NOTE that You can run the package task with --trace for debugging output if the package + fails to build or if you simply want to see what is being done as it is done). + +1. Once you have verified your new feature/bug-fix, push your branch up to GitHub. > git commit -a -m "Implemented featureX/bugfixX which ..." > git push origin mybranchname -1. Now issue a [pull request](http://help.github.com/pull-requests/) on GitHub +1. Now issue a [pull request](http://help.github.com/pull-requests/) on GitHub. # RailsInstaller Components -The next few sections detail the core copmonents that make up RailsInstaller. +The next few sections detail the core components that make up RailsInstaller. ### Ruby 1.8.7/1.9.2 on Windows @@ -99,10 +97,9 @@ wonderful folks over at the RubyInstaller (http://rubyinstaller.org/) project. ### Git The git version that is bundled into RailsInstaller is -[msysgit](http://code.google.com/p/msysgit/) +[msysgit](http://code.google.com/p/msysgit/). ### Packaging/Installer We are using [Inno Setup](http://www.jrsoftware.org/isinfo.php "Inno Setup"), -a free installer for Windows programs. - +a free installer for Windows programs. \ No newline at end of file From 198bdc4b8857e380910fa8f5d9279d263bcbba4b Mon Sep 17 00:00:00 2001 From: dathompson Date: Fri, 6 Jan 2012 08:46:33 -0800 Subject: [PATCH 2/6] added periods for consistency. reworked content for consistent notation. fixed a couple typos. removed some redundancy in language and consolidated some concepts. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9520283..d65d55b 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ built and packaged via rake tasks. * This creates the executable (.exe) package file in the pkg/ directory from the files staged during the build process in the stage/ directory. - * NOTE that You can run the package task with --trace for debugging output if the package + * NOTE - You can run the package task with --trace for debugging output if the package fails to build or if you simply want to see what is being done as it is done). 1. Once you have verified your new feature/bug-fix, push your branch up to GitHub. From f6304b47115e9f362da145b1fdbee3556c8fd73b Mon Sep 17 00:00:00 2001 From: dathompson Date: Fri, 6 Jan 2012 08:49:38 -0800 Subject: [PATCH 3/6] edited some bullet alignment --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d65d55b..5e66df1 100644 --- a/README.md +++ b/README.md @@ -48,13 +48,13 @@ built and packaged via rake tasks. 1. Implement your new feature and/or fix your bug in your newly forked Railsinstaller project code. - * The configuration file for specifying required packages can be found at + * The configuration file for specifying required packages can be found at config/railsinstaller.yml file. - * Building of the installer into the stage path for packaging is implemented by the Ruby + * Building of the installer into the stage path for packaging is implemented by the Ruby code in the lib/ directory, starting with the file lib/railsinstaller/actions.rb. - * Methods called by the actions file are implemented by lib/railsinstaller/methods.rb. + * Methods called by the actions file are implemented by lib/railsinstaller/methods.rb. 1. Next build all components onto the stage (into the stage/ directory). @@ -64,10 +64,10 @@ built and packaged via rake tasks. > rake package - * This creates the executable (.exe) package file in the pkg/ directory from the files staged + * This creates the executable (.exe) package file in the pkg/ directory from the files staged during the build process in the stage/ directory. - * NOTE - You can run the package task with --trace for debugging output if the package + * NOTE - You can run the package task with --trace for debugging output if the package fails to build or if you simply want to see what is being done as it is done). 1. Once you have verified your new feature/bug-fix, push your branch up to GitHub. From 9440661e2dc6d8d454d4dac6adb1e8236c1962e8 Mon Sep 17 00:00:00 2001 From: dathompson Date: Fri, 6 Jan 2012 08:50:20 -0800 Subject: [PATCH 4/6] edited some bullet alignment --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5e66df1..17c7f27 100644 --- a/README.md +++ b/README.md @@ -48,13 +48,13 @@ built and packaged via rake tasks. 1. Implement your new feature and/or fix your bug in your newly forked Railsinstaller project code. - * The configuration file for specifying required packages can be found at +* The configuration file for specifying required packages can be found at config/railsinstaller.yml file. - * Building of the installer into the stage path for packaging is implemented by the Ruby +* Building of the installer into the stage path for packaging is implemented by the Ruby code in the lib/ directory, starting with the file lib/railsinstaller/actions.rb. - * Methods called by the actions file are implemented by lib/railsinstaller/methods.rb. +* Methods called by the actions file are implemented by lib/railsinstaller/methods.rb. 1. Next build all components onto the stage (into the stage/ directory). @@ -64,10 +64,10 @@ built and packaged via rake tasks. > rake package - * This creates the executable (.exe) package file in the pkg/ directory from the files staged +* This creates the executable (.exe) package file in the pkg/ directory from the files staged during the build process in the stage/ directory. - * NOTE - You can run the package task with --trace for debugging output if the package +* NOTE - You can run the package task with --trace for debugging output if the package fails to build or if you simply want to see what is being done as it is done). 1. Once you have verified your new feature/bug-fix, push your branch up to GitHub. From 0aee2af4a7cfd1edc89b8c8437485db170e633e9 Mon Sep 17 00:00:00 2001 From: dathompson Date: Fri, 6 Jan 2012 08:51:06 -0800 Subject: [PATCH 5/6] edited some bullet alignment --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 17c7f27..5e66df1 100644 --- a/README.md +++ b/README.md @@ -48,13 +48,13 @@ built and packaged via rake tasks. 1. Implement your new feature and/or fix your bug in your newly forked Railsinstaller project code. -* The configuration file for specifying required packages can be found at + * The configuration file for specifying required packages can be found at config/railsinstaller.yml file. -* Building of the installer into the stage path for packaging is implemented by the Ruby + * Building of the installer into the stage path for packaging is implemented by the Ruby code in the lib/ directory, starting with the file lib/railsinstaller/actions.rb. -* Methods called by the actions file are implemented by lib/railsinstaller/methods.rb. + * Methods called by the actions file are implemented by lib/railsinstaller/methods.rb. 1. Next build all components onto the stage (into the stage/ directory). @@ -64,10 +64,10 @@ built and packaged via rake tasks. > rake package -* This creates the executable (.exe) package file in the pkg/ directory from the files staged + * This creates the executable (.exe) package file in the pkg/ directory from the files staged during the build process in the stage/ directory. -* NOTE - You can run the package task with --trace for debugging output if the package + * NOTE - You can run the package task with --trace for debugging output if the package fails to build or if you simply want to see what is being done as it is done). 1. Once you have verified your new feature/bug-fix, push your branch up to GitHub. From 8ca0651e2b924013859a742b0ee06caad69e937b Mon Sep 17 00:00:00 2001 From: dathompson Date: Fri, 6 Jan 2012 08:54:21 -0800 Subject: [PATCH 6/6] minor README edits --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5e66df1..3f45c27 100644 --- a/README.md +++ b/README.md @@ -49,12 +49,12 @@ built and packaged via rake tasks. 1. Implement your new feature and/or fix your bug in your newly forked Railsinstaller project code. * The configuration file for specifying required packages can be found at - config/railsinstaller.yml file. + config/railsinstaller.yml. - * Building of the installer into the stage path for packaging is implemented by the Ruby + * Building of the installer into the stage path for packaging is implemented by Ruby code in the lib/ directory, starting with the file lib/railsinstaller/actions.rb. - * Methods called by the actions file are implemented by lib/railsinstaller/methods.rb. + * Methods called by the actions.rb file are implemented by lib/railsinstaller/methods.rb. 1. Next build all components onto the stage (into the stage/ directory).