Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 75 lines (51 sloc) 2.65 kb
768dfaa @laserlemon Add dependency status to README
laserlemon authored
1 # factory_girl [![Build Status](https://secure.travis-ci.org/thoughtbot/factory_girl.png)](http://travis-ci.org/thoughtbot/factory_girl?branch=master) [![Dependency Status](https://gemnasium.com/thoughtbot/factory_girl.png)](https://gemnasium.com/thoughtbot/factory_girl)
df67e90 change readme to markdown and add in credit and license info
Chad Pytel authored
2
3 factory_girl is a fixtures replacement with a straightforward definition syntax, support for multiple build strategies (saved instances, unsaved instances, attribute hashes, and stubbed objects), and support for multiple factories for the same class (user, admin_user, and so on), including factory inheritance.
4
cfaa00c @joshuaclayton Remove Rails 2 support
joshuaclayton authored
5 If you want to use factory_girl with Rails, see
30e13dd @weppos http => https
weppos authored
6 [factory_girl_rails](https://github.com/thoughtbot/factory_girl_rails).
3acd41d @jferris Extract examples out to a different file so that the readme people se…
jferris authored
7
8 Documentation
9 -------------
10
30e13dd @weppos http => https
weppos authored
11 You should find the documentation for your version of factory_girl on [Rubygems](https://rubygems.org/gems/factory_girl).
3acd41d @jferris Extract examples out to a different file so that the readme people se…
jferris authored
12
3dbbf4e @croaky make getting started link work
croaky authored
13 See [GETTING_STARTED](https://github.com/thoughtbot/factory_girl/blob/master/GETTING_STARTED.md) for information on defining and using factories.
df67e90 change readme to markdown and add in credit and license info
Chad Pytel authored
14
3292d63 @gmile More clear install message
gmile authored
15 Install
df67e90 change readme to markdown and add in credit and license info
Chad Pytel authored
16 --------
17
3f15c23 @mike-burns Clear up the language for pedantic people.
mike-burns authored
18 ```shell
3292d63 @gmile More clear install message
gmile authored
19 gem install factory_girl
20 ```
21 or add the following line to Gemfile:
8ad1cc6 @gabebw Fix syntax highlighting
gabebw authored
22
3292d63 @gmile More clear install message
gmile authored
23 ```ruby
24 gem 'factory_girl'
25 ```
3f15c23 @mike-burns Clear up the language for pedantic people.
mike-burns authored
26 and run `bundle install` from your shell.
df67e90 change readme to markdown and add in credit and license info
Chad Pytel authored
27
bed50ec @croaky [#324] Add supported Ruby versions to README
croaky authored
28 Supported Ruby versions
29 -----------------------
30
4311689 @joshuaclayton Update README to include JRuby information
joshuaclayton authored
31 The FactoryGirl 3.x+ series supports MRI Ruby 1.9. Additionally, FactoryGirl
32 3.6+ supports JRuby 1.6.7.2+ while running in 1.9 mode. See
33 [GETTING_STARTED](https://github.com/thoughtbot/factory_girl/blob/master/GETTING_STARTED.md)
34 for more information on configuring the JRuby environment.
bed50ec @croaky [#324] Add supported Ruby versions to README
croaky authored
35
4311689 @joshuaclayton Update README to include JRuby information
joshuaclayton authored
36 For versions of Ruby prior to 1.9, please use FactoryGirl 2.x.
bed50ec @croaky [#324] Add supported Ruby versions to README
croaky authored
37
df67e90 change readme to markdown and add in credit and license info
Chad Pytel authored
38 More Information
39 ----------------
40
30e13dd @weppos http => https
weppos authored
41 * [Rubygems](https://rubygems.org/gems/factory_girl)
df67e90 change readme to markdown and add in credit and license info
Chad Pytel authored
42 * [Mailing list](http://groups.google.com/group/factory_girl)
30e13dd @weppos http => https
weppos authored
43 * [Issues](https://github.com/thoughtbot/factory_girl/issues)
11a79a0 @weppos Update Giant Robots blog URL
weppos authored
44 * [GIANT ROBOTS SMASHING INTO OTHER GIANT ROBOTS](http://robots.thoughtbot.com/)
df67e90 change readme to markdown and add in credit and license info
Chad Pytel authored
45
46 Contributing
47 ------------
48
30e13dd @weppos http => https
weppos authored
49 Please see the [contribution guidelines](https://github.com/thoughtbot/factory_girl/blob/master/CONTRIBUTION_GUIDELINES.md).
df67e90 change readme to markdown and add in credit and license info
Chad Pytel authored
50
51 Credits
52 -------
53
54 factory_girl was written by Joe Ferris with contributions from several authors, including:
55
56 * Alex Sharp
57 * Eugene Bolshakov
58 * Jon Yurek
59 * Josh Nichols
60 * Josh Owens
61 * Nate Sutton
1f0e2eb @joshuaclayton Attribution
joshuaclayton authored
62 * Josh Clayton
63 * Thomas Walpole
df67e90 change readme to markdown and add in credit and license info
Chad Pytel authored
64
65 ![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
66
67 factory_girl is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
68
69 The names and logos for thoughtbot are trademarks of thoughtbot, inc.
70
71 License
72 -------
73
74 factory_girl is Copyright © 2008-2011 Joe Ferris and thoughtbot. It is free software, and may be redistributed under the terms specified in the LICENSE file.
Something went wrong with that request. Please try again.