Commit f3d66b480d9dde05da52a5b320cb534411479aa8
1 parent
fe3e01fb
Exists in
master
and in
1 other branch
moved README_FOR_TEMPLATE to README.markdown
Showing
2 changed files
with
97 additions
and
97 deletions
Show diff stats
| @@ -0,0 +1,97 @@ | @@ -0,0 +1,97 @@ | ||
| 1 | +This is Heroku Suspenders, the thoughtbot rails template modified to be used for deployment to Heroku. To create a new project, checkout this | ||
| 2 | +repository and run: | ||
| 3 | + | ||
| 4 | + ./script/create_project projectname | ||
| 5 | + | ||
| 6 | +This will create a project in ../projectname. You should then follow the | ||
| 7 | +instructions on Github to upload that project there. This script creates an | ||
| 8 | +entirely new git repository, and is not meant to be used against an existing | ||
| 9 | +repo. | ||
| 10 | + | ||
| 11 | +When making a change to a project that was created via this template, consider | ||
| 12 | +whether it's a change that should be made across all projects. If so, then | ||
| 13 | +make the change in this template, and pull it into your project via: | ||
| 14 | + | ||
| 15 | + git pull heroku_suspenders master | ||
| 16 | + | ||
| 17 | +About Suspenders | ||
| 18 | +---------------- | ||
| 19 | + | ||
| 20 | +Suspenders was created for use at thoughtbot, inc. (http://thoughtbot.com) as a | ||
| 21 | +baseline application setup, with reasonable default plugins that the majority (if not all) | ||
| 22 | +of our applications used, as well as best-practice configuration options. | ||
| 23 | + | ||
| 24 | +Suspenders currently includes Rails 2.3.2 | ||
| 25 | + | ||
| 26 | +Gems (unpacked in vendor/gems): | ||
| 27 | +------------------------------- | ||
| 28 | + | ||
| 29 | +For record pagination: | ||
| 30 | + | ||
| 31 | + will_paginate | ||
| 32 | + | ||
| 33 | +For text formatting: | ||
| 34 | + | ||
| 35 | + RedCloth | ||
| 36 | + | ||
| 37 | +For testing: | ||
| 38 | + | ||
| 39 | + mocha | ||
| 40 | + factory_girl | ||
| 41 | + shoulda | ||
| 42 | + | ||
| 43 | +Plugins (in vendor/plugins): | ||
| 44 | +---------------------------- | ||
| 45 | + | ||
| 46 | + hoptoad_notifier | ||
| 47 | + limerick_rake | ||
| 48 | + | ||
| 49 | +Initializers (in config/initializers) | ||
| 50 | +------------------------------------- | ||
| 51 | + | ||
| 52 | + action_mailer_configs.rb | ||
| 53 | + We use SMTP by default in all applications. | ||
| 54 | + | ||
| 55 | + hoptoad.rb | ||
| 56 | + Get your API key at http://hoptoadapp.com | ||
| 57 | + | ||
| 58 | + requires.rb | ||
| 59 | + Automatically requires everything in | ||
| 60 | + lib/ | ||
| 61 | + lib/extensions | ||
| 62 | + test/mocks/RAILS_ENV (Removed in Rails 2, we decided to keep it) | ||
| 63 | + Add other things you need to require in here. | ||
| 64 | + | ||
| 65 | + time_formats.rb | ||
| 66 | + Two time formats are available by default, :short_date and :long_date. | ||
| 67 | + Add other time formats here. | ||
| 68 | + | ||
| 69 | +Rake Tasks | ||
| 70 | +---------- | ||
| 71 | + | ||
| 72 | +Rake tasks are contained in the limerick_rake gem. | ||
| 73 | + | ||
| 74 | + bootstrap | ||
| 75 | + Provides rake tasks for loading data into the database. These are used for an initial application dataset needed for production. | ||
| 76 | + | ||
| 77 | +Testing | ||
| 78 | +------- | ||
| 79 | + | ||
| 80 | +Testing is done utilizing Test::Unit, Shoulda, factory_girl, and mocha. | ||
| 81 | + | ||
| 82 | +factory_girl is a fixture replacement library, following the factory pattern. Place your | ||
| 83 | +factories in test/factories.rb. The fixture directory has been removed, as fixtures are not | ||
| 84 | +used. | ||
| 85 | + | ||
| 86 | +Shoulda is a pragmatic testing framework for TDD and BDD built on top of Test::Unit. | ||
| 87 | + | ||
| 88 | +jferris-mocha --version '0.9.5.0.1241126838' --source gems.github.com | ||
| 89 | +thoughtbot-factory_girl --version '>= 1.2.0' --source gems.github.com | ||
| 90 | +thoughtbot-shoulda --version '>= 2.10.1' --source gems.github.com | ||
| 91 | + | ||
| 92 | +Mascot | ||
| 93 | +------ | ||
| 94 | + | ||
| 95 | +The official Suspenders mascot is Suspenders Boy: | ||
| 96 | + | ||
| 97 | + http://media.tumblr.com/1TEAMALpseh5xzf0Jt6bcwSMo1_400.png |
doc/README_FOR_TEMPLATE
| @@ -1,97 +0,0 @@ | @@ -1,97 +0,0 @@ | ||
| 1 | -This is Heroku Suspenders, the thoughtbot rails template modified to be used for deployment to Heroku. To create a new project, checkout this | ||
| 2 | -repository and run: | ||
| 3 | - | ||
| 4 | - ./script/create_project projectname | ||
| 5 | - | ||
| 6 | -This will create a project in ../projectname. You should then follow the | ||
| 7 | -instructions on Github to upload that project there. This script creates an | ||
| 8 | -entirely new git repository, and is not meant to be used against an existing | ||
| 9 | -repo. | ||
| 10 | - | ||
| 11 | -When making a change to a project that was created via this template, consider | ||
| 12 | -whether it's a change that should be made across all projects. If so, then | ||
| 13 | -make the change in this template, and pull it into your project via: | ||
| 14 | - | ||
| 15 | - git pull suspenders master | ||
| 16 | - | ||
| 17 | -About Suspenders | ||
| 18 | ----------------- | ||
| 19 | - | ||
| 20 | -Suspenders was created for use at thoughtbot, inc. (http://thoughtbot.com) as a | ||
| 21 | -baseline application setup, with reasonable default plugins that the majority (if not all) | ||
| 22 | -of our applications used, as well as best-practice configuration options. | ||
| 23 | - | ||
| 24 | -Suspenders currently includes Rails 2.3.2 | ||
| 25 | - | ||
| 26 | -Gems (unpacked in vendor/gems): | ||
| 27 | -------------------------------- | ||
| 28 | - | ||
| 29 | -For record pagination: | ||
| 30 | - | ||
| 31 | - will_paginate | ||
| 32 | - | ||
| 33 | -For text formatting: | ||
| 34 | - | ||
| 35 | - RedCloth | ||
| 36 | - | ||
| 37 | -For testing: | ||
| 38 | - | ||
| 39 | - mocha | ||
| 40 | - factory_girl | ||
| 41 | - shoulda | ||
| 42 | - | ||
| 43 | -Plugins (in vendor/plugins): | ||
| 44 | ----------------------------- | ||
| 45 | - | ||
| 46 | - hoptoad_notifier | ||
| 47 | - limerick_rake | ||
| 48 | - | ||
| 49 | -Initializers (in config/initializers) | ||
| 50 | -------------------------------------- | ||
| 51 | - | ||
| 52 | - action_mailer_configs.rb | ||
| 53 | - We use SMTP by default in all applications. | ||
| 54 | - | ||
| 55 | - hoptoad.rb | ||
| 56 | - Get your API key at http://hoptoadapp.com | ||
| 57 | - | ||
| 58 | - requires.rb | ||
| 59 | - Automatically requires everything in | ||
| 60 | - lib/ | ||
| 61 | - lib/extensions | ||
| 62 | - test/mocks/RAILS_ENV (Removed in Rails 2, we decided to keep it) | ||
| 63 | - Add other things you need to require in here. | ||
| 64 | - | ||
| 65 | - time_formats.rb | ||
| 66 | - Two time formats are available by default, :short_date and :long_date. | ||
| 67 | - Add other time formats here. | ||
| 68 | - | ||
| 69 | -Rake Tasks | ||
| 70 | ----------- | ||
| 71 | - | ||
| 72 | -Rake tasks are contained in the limerick_rake gem. | ||
| 73 | - | ||
| 74 | - bootstrap | ||
| 75 | - Provides rake tasks for loading data into the database. These are used for an initial application dataset needed for production. | ||
| 76 | - | ||
| 77 | -Testing | ||
| 78 | -------- | ||
| 79 | - | ||
| 80 | -Testing is done utilizing Test::Unit, Shoulda, factory_girl, and mocha. | ||
| 81 | - | ||
| 82 | -factory_girl is a fixture replacement library, following the factory pattern. Place your | ||
| 83 | -factories in test/factories.rb. The fixture directory has been removed, as fixtures are not | ||
| 84 | -used. | ||
| 85 | - | ||
| 86 | -Shoulda is a pragmatic testing framework for TDD and BDD built on top of Test::Unit. | ||
| 87 | - | ||
| 88 | -jferris-mocha --version '0.9.5.0.1241126838' --source gems.github.com | ||
| 89 | -thoughtbot-factory_girl --version '>= 1.2.0' --source gems.github.com | ||
| 90 | -thoughtbot-shoulda --version '>= 2.10.1' --source gems.github.com | ||
| 91 | - | ||
| 92 | -Mascot | ||
| 93 | ------- | ||
| 94 | - | ||
| 95 | -The official Suspenders mascot is Suspenders Boy: | ||
| 96 | - | ||
| 97 | - http://media.tumblr.com/1TEAMALpseh5xzf0Jt6bcwSMo1_400.png |