appleseed 0.1.2 → 0.1.3

data/README.rdoc

@@ -9,6 +9,11 @@ high-volume web shops.  A graphic designer can create a site, push the code to G
 the site to Heroku without the assistance of a developer.  Then a developer can easily join the
 project to build out the back-end and assist the graphic designer with the front-end.
 
+Here is an {example GitHub project}[http://github.com/endymion/generated-by-appleseed] that
+Appleseed generated, and here is the
+{Heroku web application}[http://generated-by-appleseed.heroku.com/] for that example project.
+Note the example layout, default home page, and Blueprint styling provided by Compass.
+
 = Usage
 
 == Step 1: Install Appleseed
@@ -73,13 +78,23 @@ but do NOT push to Heroku:
   git commit -m "Conflict."
   git push github master
 
+== Step 5: Deploy Your Changes
+
+Deploying your web site after you make changes is really easy.  Just push to the "heroku" remote:
+
+  git push heroku master
+  
+== Step 6: Goto Step 4
+
+Repeat until the money runs out.
+
 = Final Product
 
 Appleseed generates a web application that's more than just the default generated Rails 3 template.
 Instead of just a default working Rails application, you also get a default ("root") controller
 and a root route to a home page.  You get a layout based on HAML, and the Blueprint CSS framework
 provided by Compass.  You get the RSpec and Cucumber testing frameworks and sample tests.  The
-final product is ready for new HTML/CSS files from graphic designers.
+final product is ready for new HTML/CSS files and images from graphic designers.
 
 The final product does NOT contain any database models, or an administrative back-end.  It only
 includes a default controller so that graphic designers can easily add HTML files.
@@ -106,6 +121,43 @@ A simple way to customize the Rails template that Appleseed uses is to fork the
 on GitHub and then edit the lib/appleseed/generator.rb file to use your forked project's
 default template URL instead of http://github.com/endymion/appleseed/raw/master/templates/default.rb
 
-== Copyright
+= Prerequisites
+
+== Tools
+
+* Git (installed on Snow Leopard)
+* Ruby 1.8.7 (installed on Snow Leopard)
+* RubyGems (installed on Snow Leopard)
+
+== Ruby Gems
+
+* Rails ("gem install rails")
+* Heroku ("gem install heroku")
+
+== GitHub Account
+
+You will need an account at GitHub[http://www.github.com].  {Set up}[http://help.github.com/git-email-settings/] your GitHub name and email
+on your local computer.  Then also {set up}[http://github.com/blog/180-local-github-config]
+your GitHub user and API token on your local computer.  Then make sure that you
+have an {SSH key}[http://help.github.com/mac-key-setup/] set up and added to your
+GitHub account.
+
+== Heroku Account
+
+You will also need an account at Heroku[http://docs.heroku.com/heroku-command].  Install
+the Heroku gem and then use "heroku keys:add" to link your local computer to your Heroku
+account.
+
+== Appleseed
+
+Once you have the above prerequisites, install Appleseed with "gem install appleseed".  Now
+you're ready to generate web sites!
+
+= Inspiration
+
+* Jeweler[http://github.com/technicalpickles/jeweler]
+* {Johnny Appleseed}[http://en.wikipedia.org/wiki/Johnny_Appleseed]
+
+= Copyright
 
-Copyright (c) 2010 Ryan Alyn Porter. See LICENSE for details.
+Copyright (c) 2010 Ryan Alyn Porter. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/appleseed.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{appleseed}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Alyn Porter"]
-  s.date = %q{2010-08-28}
+  s.date = %q{2010-08-30}
   s.default_executable = %q{appleseed}
   s.description = %q{Generator for a Rails 3 app that will also push the project to GitHub and Heroku.}
   s.executables = ["appleseed"]

data/lib/appleseed/generator.rb

@@ -50,11 +50,11 @@ class Appleseed
 
       self.target_dir             = self.project_name
 
-      self.summary                = options[:summary] || 'TODO: one-line summary of your gem'
-      self.description            = options[:description] || 'TODO: longer description of your gem'
+      self.summary                = options[:summary] || 'TODO: one-line summary of your web site'
+      self.description            = options[:description] || 'TODO: longer description of your web site'
 
-      # self.template_url    = options[:template_url] || 'http://github.com/endymion/appleseed/raw/master/templates/default.rb'
-      self.template_url    = options[:template_url] || 'http://localhost/projects/appleseed/templates/default.rb'
+      self.template_url    = options[:template_url] || 'http://github.com/endymion/appleseed/raw/master/templates/default.rb'
+      # self.template_url    = options[:template_url] || 'http://localhost/projects/appleseed/templates/default.rb'
 
       self.user_name       = options[:user_name]
       self.user_email      = options[:user_email]

data/templates/root_controller.rb

@@ -4,8 +4,88 @@ run 'rm public/images/rails.png'
 generate :controller, 'root', 'root'
 route "root :to => 'root#root'"
 
+append_file 'app/stylesheets/screen.scss', <<-END
+
+// Added by Appleseed to make the default sections more visible.  You should probably remove this.
+body.two-col {
+  #container {
+    @include showgrid
+  }
+  #header, #footer {
+    background-color: #DDD;
+    margin-top: 1em;
+    margin-bottom: 1em;
+  }
+  #content {
+    background-color: #EEE;
+  }
+}
+END
+
+run 'compass compile'
+
+run 'rm app/views/layouts/application.html.haml'
+file 'app/views/layouts/application.html.haml', <<-END
+!!!
+%html
+  %head
+    %title [INSERT TITLE HERE]
+    = stylesheet_link_tag 'compiled/screen.css', :media => 'screen, projection'
+    = stylesheet_link_tag 'compiled/print.css', :media => 'print'
+    /[if lt IE 8]
+      = stylesheet_link_tag 'compiled/ie.css', :media => 'screen, projection'
+    = javascript_include_tag :defaults
+    = csrf_meta_tag
+  %body.bp.two-col
+    #container
+      #header
+        This header is in the layout template in app/views/layouts/application.html.haml
+      = yield
+      #footer
+        This footer is in the layout template in app/views/layouts/application.html.haml
+END
+
 run 'rm app/views/root/root.html.haml'
 file 'app/views/root/root.html.haml', <<-END
-#hello
-  Hello from your new app!
+#sidebar
+  %p
+    This sidebar is in the root action template, in the root controller, in app/views/root/root.html.html
+  %p
+    %ul
+      %li navigation
+      %li home
+      %li contact
+      %li etc
+#content
+  %h1
+    Welcome to your new web site!
+  %p
+    This web site is powered by a Rails 3 web application.  Lots of documentation is available
+    for Rails.  Start
+    %a{:href => 'http://weblog.rubyonrails.org/2010/8/28/rails-has-great-documentation'} here.
+  %p
+    The contents of this page are in the root action template, in the root controller,
+    in app/views/root/root.html.haml.  The template files for this web application project are
+    in
+    %a{:src => 'http://haml-lang.com/docs.html'} HAML
+    , which is a powerful shorthand notation for quickly writing HTML that coordinates
+    beautifully with SCSS for styling the page.  The HAML documentation is
+    %a{:src => 'http://haml-lang.com/docs/yardoc/file.HAML_REFERENCE.html'} here.
+  %p
+    This page is styled using
+    %a{:href => 'http://www.blueprintcss.org/'} Blueprint.
+    You can see
+    demos of what Blueprint can provide,
+    %a{:src => 'http://www.blueprintcss.org/tests/'} here.
+    This project uses the Compass implementation of Blueprint in SCSS, documented
+    %a{:src => 'http://compass-style.org/docs/reference/blueprint/'} here.
+  %p
+    The CSS styling for this page was generated from the SCSS file in
+    app/stylesheets/screen.scss.  There is a section at the bottom of the file that activates
+    the grid and the background colors on the various page sections provided by the Blueprint
+    styles directly above it.  You probably want to start your web site project by locating
+    that file and removing the grid and background colors.  That file is where you should
+    start adding your custom styles.
+  %p
+    Place your images into public/images.
 END

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: appleseed
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Ryan Alyn Porter
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-28 00:00:00 -04:00
+date: 2010-08-30 00:00:00 -04:00
 default_executable: appleseed
 dependencies: 
 - !ruby/object:Gem::Dependency