README.markdown

   1 MerbMart README
   2 ===============
   3
   4 MerbMart is an *open-source e-commerce engine*, developed on top of the recent
   5 Ruby-language Merb MVC framework. Although MerbMart is designed for e-commerce
   6 sites of all sizes, the speed and scalability of the Merb framework make it
   7 scalable for even large online vendors.
   8
   9 In addition to Merb framework, MerbMart is also built on the following open-
  10 source foundations:
  11
  12  * DataMapper (0.9 branch), for object relation mapping (ORM) and persistence.
  13  * RSpec, for behavio(u)r driven development (BDD).
  14  * ActiveMerchant, for Credit Card, payment and shipping processing.
  15    as well as attachmerb\_fu, merb\_paginate.
  16
  17 See INSTALL or the project wiki for a full list of dependencies.
  18
  19 MerbMart is a loose port of the Substruct e-commerce application for Ruby-on-
  20 Rails. The initial 0.1 release of MerbMart will be a feature-equivalent port
  21 of Substruct 0.97. MerbMart borrows many ideas, its database entity-
  22 relationship design and some lines of code from Substruct, and is grateful to i
  23 ts developers for developing such a great application:
  24   http://code.google.com/p/substruct/
  25   http://substruct.subimage.com/
  26
  27 Developer ReadMe
  28 ----------------
  29
  30 **WARNING** : MerbMart is at a very early development stages. At this stage,
  31 the application should be considered only for consumption by advanced Ruby and
  32 Merb developers. If you're looking for something for production consumption,
  33 or not yet ready to jump from Ruby on Rails, then we would strongly advise
  34 trying Substruct.
  35
  36 **REQUEST** : Your development support is very much appreciated. Please
  37 contact us below if you're interested in lending a hand with the development
  38 of this project. Or alternatively, clone the code, fork it, create some
  39 patches and let us know when you're done.
  40
  41 Getting the Source
  42 ------------------
  43
  44     git clone git://github.com/myabc/merb_mart.git
  45
  46 The following mirrors are also available:
  47
  48     git://repo.or.cz/merb_mart.git
  49     http://repo.or.cz/r/merb_mart.git
  50
  51 Installation and Setup
  52 ----------------------
  53
  54 Please see the INSTALL file for details on getting up and running with
  55 MerbMart.
  56
  57 Licensing and Copyright
  58 -----------------------
  59
  60 MerbMart is released under the **Artistic License**. Copyright information,
  61 as well as a copy of the Artistic License may be found in the LICENSE file.
  62
  63 Support
  64 -------
  65
  66 **WARNING REPEATED** : MerbMart is still at a very early stage of its
  67 development. You should not use this code unless you're reasonably secure with
  68 the Ruby language, and the DataMapper and Merb frameworks. That said, _please
  69 do get involved_ - and if you're happy to contribute back with bug reports and
  70 patches, then we'll be happy to help you get the application up and running.
  71
  72 Your best source for support currently is either the wiki, IRC or the mailing
  73 list:
  74
  75  * **MerbMart Wiki** (this is its temporary residence):
  76     http://github.com/myabc/merb_mart/wikis
  77  * **MerbMart mailing list**:
  78     <http://groups.google.com/group/merb_mart>
  79  * **MerbMart homepage**: _coming soon_
  80  * Contact the developers directly:
  81     - <alex@alexcolesportfolio.com> | myabc on #datamapper, #merb IRC
  82