= Installing Model-Glue =

To install Model-Glue, all you need to do is copy a few files and possibly make a few mappings.

== Prerequisites ==

Model-Glue 3.1 requires a few other bits to run. Installation is painless, and should take about five minutes.

1. The !ColdSpring Framework must be downloaded and installed. It's available at [http://www.coldspringframework.org www.coldspringframework.org].

2. If you want to do any of the automated database interaction, such as scaffolding, a supported ORM for !ColdFusion must be available. The ORMs supported by Model-Glue 3.1 are:

  1. The Reactor framework (available from [http://trac.reactorframework.com trac.reactorframework.com])
  1. The Transfer ORM library (available from [http://www.transfer-orm.com www.transfer-orm.com])

== To Install Model-Glue on a Default Installation of !ColdFusion (No mappings required!): ==

A default installation of !ColdFusion is what you've got if you've simply installed !ColdFusion and used your existing Web root, like "c:\inetpub\wwwroot" as the location of your documents. In a default installation with a Web root of "c:\inetpub\wwwroot," a !ColdFusion component named "!ModelGlue.Util.!GenericCollection" would be in the "c:\inetpub\wwwroot\!ModelGlue\Util" directory.

  1. Unzip the Model-Glue distribution .zip
  1. Copy the !ModelGlue folder into your Web root

That's it.

== To Install the Coldspring Framework and/or the above mentioned ORMS with Model-Glue: ==
  1. If no mappings are used, the !ColdSpring Framework folder or the ORM frameworks are placed in the root folder at the same level as the Model-Glue folder.
  2. If you are running CF 8 or 9 you can make an application specific mapping for the framework folder's location outside the web root. Regular mappings set up in the CF administrator will work as well.

== To Install Model-Glue using !ColdFusion mappings: ==

  1. Unzip the Model-Glue distribution .zip
  1. Put the !ModelGlue folder somewhere permanent.
  1. Map /!ModelGlue to wherever you've moved the !ModelGlue folder.

That's it.