Skip to content

Commit 715a902

Browse files
committed
update README
1 parent c305df6 commit 715a902

File tree

1 file changed

+71
-1
lines changed

1 file changed

+71
-1
lines changed

README.textile

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,77 @@ Use the @-T@ flag to skip Test::Unit files.
7979

8080
The @$@ character indicates a shell prompt; don't include it when you run the command.
8181

82-
This creates a new Rails app (with the name "myapp") on your computer.
82+
This creates a new Rails app (with the name "myapp") on your computer. You can use a different name if you wish.
83+
84+
You'll see a prompt:
85+
86+
<pre>
87+
question Install an example application?
88+
1) I want to build my own application
89+
2) rails3-bootstrap-devise-cancan
90+
3) rails3-devise-rspec-cucumber
91+
4) rails3-mongoid-devise
92+
5) rails3-mongoid-omniauth
93+
6) rails3-subdomains
94+
</pre>
95+
96+
Choose *rails3-devise-rspec-cucumber*. The Rails Composer tool may give you other options (other choices may have been added since these notes were written).
97+
98+
The application generator template will ask you for additional preferences:
99+
100+
<pre>
101+
question Web server for development?
102+
1) WEBrick (default)
103+
2) Thin
104+
3) Unicorn
105+
4) Puma
106+
question Web server for production?
107+
1) Same as development
108+
2) Thin
109+
3) Unicorn
110+
4) Puma
111+
question Template engine?
112+
1) ERB
113+
2) Haml
114+
3) Slim
115+
extras Set a robots.txt file to ban spiders? (y/n)
116+
extras Create a project-specific rvm gemset and .rvmrc? (y/n)
117+
extras Create a GitHub repository? (y/n)
118+
</pre>
119+
120+
h4. Web Servers
121+
122+
Use the default WEBrick server for convenience. If you plan to deploy to Heroku, select "thin" as your production webserver.
123+
124+
h4. Template Engine
125+
126+
The example application uses the default "ERB" Rails template engine. Optionally, you can use another template engine, such as Haml or Slim. See instructions for "Haml and Rails":http://railsapps.github.com/rails-haml.html.
127+
128+
h4. Other Choices
129+
130+
Set a robots.txt file to ban spiders if you want to keep your new site out of Google search results.
131+
132+
It is a good idea to use "rvm":https://rvm.io/, the Ruby Version Manager, and create a project-specific rvm gemset and .rvmrc file (not available on Windows). See "Installing Rails":http://railsapps.github.com/installing-rails.html.
133+
134+
If you choose to create a GitHub repository, the generator will prompt you for a GitHub username and password.
135+
136+
h4. Troubleshooting
137+
138+
If you get an error "OpenSSL certificate verify failed" or "Gem::RemoteFetcher::FetchError: SSL_connect" see the article "OpenSSL errors and Rails":http://railsapps.github.com/openssl-certificate-verify-failed.html.
139+
140+
If you get an error like this:
141+
142+
<pre>
143+
Your bundle is complete! Use `bundle show [gemname]` to see where a bundled gem is installed.
144+
composer Running 'after bundler' callbacks.
145+
The template [...] could not be loaded.
146+
Error: You have already activated ..., but your Gemfile requires ....
147+
Using bundle exec may solve this.
148+
</pre>
149+
150+
It's due to conflicting gem versions. See the article "Rails Error: “You have already activated (…)”":http://railsapps.github.com/rails-error-you-have-already-activated.html.
151+
152+
Other problems? Check the "issues":https://github.com/RailsApps/rails3-application-templates/issues.
83153

84154
h3. Edit the README
85155

0 commit comments

Comments
 (0)