Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Edit readme #5

Merged
merged 6 commits into from

2 participants

@dathompson

I've provided some edits to the README.md file.

Edits:

  • added periods to end of all items for consistency.
  • fixed a couple of misspelled words
  • attempted to remove some redundancy in instructions and consolidate verbiage
  • added bullet notation for clearer structure

Thanks for this project and all of your work!

dathompson added some commits
dathompson -f a17e641
dathompson added periods for consistency. reworked content for consistent notati…
…on. fixed a couple typos. removed some redundancy in language and consolidated some concepts.
198bdc4
dathompson edited some bullet alignment f6304b4
dathompson edited some bullet alignment 9440661
dathompson edited some bullet alignment 0aee2af
dathompson minor README edits 8ca0651
@wayneeseguin

Thanks!!

@wayneeseguin wayneeseguin merged commit 9697731 into railsinstaller:master
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Jan 6, 2012
  1. -f

    dathompson authored
  2. added periods for consistency. reworked content for consistent notati…

    dathompson authored
    …on. fixed a couple typos. removed some redundancy in language and consolidated some concepts.
  3. edited some bullet alignment

    dathompson authored
  4. edited some bullet alignment

    dathompson authored
  5. edited some bullet alignment

    dathompson authored
  6. minor README edits

    dathompson authored
This page is out of date. Refresh to see the latest.
Showing with 27 additions and 30 deletions.
  1. +27 −30 README.md
View
57 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.
- > rake build
+ * 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.rb 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 - 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 <description>..."
> 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.
Something went wrong with that request. Please try again.