Most of the time I use readme.md file to explain how to properly install the dependencies and run the application for first time. I use [something like](https://gist.github.com/3058000) as a README.md scaffold. Just an idea, What would you guys think about replacing the current readme with something like this? https://gist.github.com/3058000 Oguz Bilgic Thanks -- You received this message because you are subscribed to the Google Groups "Ruby on Rails: Core" group. To view this discussion on the web visit https://groups.google.com/d/msg/rubyonrails-core/-/eq_cpgPczHYJ. To post to this group, send email to rubyonrails-core@googlegroups.com. To unsubscribe from this group, send email to rubyonrails-core+unsubscribe@googlegroups.com. For more options, visit this group at http://groups.google.com/group/rubyonrails-core?hl=en.
You mean to generate this as default doc/README_FOR_APP? -- You received this message because you are subscribed to the Google Groups "Ruby on Rails: Core" group. To post to this group, send email to rubyonrails-core@googlegroups.com. To unsubscribe from this group, send email to rubyonrails-core+unsubscribe@googlegroups.com. For more options, visit this group at http://groups.google.com/group/rubyonrails-core?hl=en.
My suggestion is to generate this as the main README file. On Sunday, December 16, 2012 5:37:26 AM UTC-8, Xavier Noria wrote:> > You mean to generate this as default doc/README_FOR_APP? >-- You received this message because you are subscribed to the Google Groups "Ruby on Rails: Core" group. To view this discussion on the web visit https://groups.google.com/d/msg/rubyonrails-core/-/KUn_fX-PetgJ. To post to this group, send email to rubyonrails-core@googlegroups.com. To unsubscribe from this group, send email to rubyonrails-core+unsubscribe@googlegroups.com. For more options, visit this group at http://groups.google.com/group/rubyonrails-core?hl=en.
+1 for making default generated README more useful. It should not be a guide or a tutorial on using rails; it should just describe how to bundle the application, how to configure it, and how to run tests & server. On Tuesday, December 18, 2012 1:35:34 PM UTC+3, Oguz Bilgic wrote:> > My suggestion is to generate this as the main README file. > > On Sunday, December 16, 2012 5:37:26 AM UTC-8, Xavier Noria wrote: >> >> You mean to generate this as default doc/README_FOR_APP? >> >-- You received this message because you are subscribed to the Google Groups "Ruby on Rails: Core" group. To view this discussion on the web visit https://groups.google.com/d/msg/rubyonrails-core/-/eMZRb7ZYAwwJ. To post to this group, send email to rubyonrails-core@googlegroups.com. To unsubscribe from this group, send email to rubyonrails-core+unsubscribe@googlegroups.com. For more options, visit this group at http://groups.google.com/group/rubyonrails-core?hl=en.
Both hands are up. I think, this change can inspire people who work with the resulting Ruby on Rails project to reference all project''s workflow in a README and keep it up-to-date. It isn''t happening currently. We are supporting our project for more then a year, and only two months ago we started to edit README. The one which is generated by rails is totally useless. воскресенье, 16 декабря 2012 г., 3:36:39 UTC+4 пользователь Oguz Bilgic написал:> > Most of the time I use readme.md file to explain how to properly install > the dependencies and run the application for first time. I use [something > like](https://gist.github.com/3058000) as a README.md scaffold. > > Just an idea, What would you guys think about replacing the current readme > with something like this? > > https://gist.github.com/3058000 > > Oguz Bilgic > Thanks > > >-- You received this message because you are subscribed to the Google Groups "Ruby on Rails: Core" group. To view this discussion on the web visit https://groups.google.com/d/msg/rubyonrails-core/-/GwEL7QamEGkJ. To post to this group, send email to rubyonrails-core@googlegroups.com. To unsubscribe from this group, send email to rubyonrails-core+unsubscribe@googlegroups.com. For more options, visit this group at http://groups.google.com/group/rubyonrails-core?hl=en.
I think that this is something that would differ incredibly from app to app. For instance, I would not install Ruby using apt-get myself. While I like the idea of having it be a "Getting Started" doc for an app, I don''t think that Rails could come with a cohesive default that would work for everyone. -1 to this change. On 02/01/2013, at 11:52, Николай Шебанов <nikolay.shebanov@gmail.com> wrote:> Both hands are up. I think, this change can inspire people who work with the resulting Ruby on Rails project to reference all project''s workflow in a README and keep it up-to-date. It isn''t happening currently. > > We are supporting our project for more then a year, and only two months ago we started to edit README. The one which is generated by rails is totally useless. > > воскресенье, 16 декабря 2012 г., 3:36:39 UTC+4 пользователь Oguz Bilgic написал: >> >> Most of the time I use readme.md file to explain how to properly install the dependencies and run the application for first time. I use [something like](https://gist.github.com/3058000) as a README.md scaffold. >> >> Just an idea, What would you guys think about replacing the current readme with something like this? >> >> https://gist.github.com/3058000 >> >> Oguz Bilgic >> Thanks > > -- > You received this message because you are subscribed to the Google Groups "Ruby on Rails: Core" group. > To view this discussion on the web visit https://groups.google.com/d/msg/rubyonrails-core/-/GwEL7QamEGkJ. > To post to this group, send email to rubyonrails-core@googlegroups.com. > To unsubscribe from this group, send email to rubyonrails-core+unsubscribe@googlegroups.com. > For more options, visit this group at http://groups.google.com/group/rubyonrails-core?hl=en.-- You received this message because you are subscribed to the Google Groups "Ruby on Rails: Core" group. To post to this group, send email to rubyonrails-core@googlegroups.com. To unsubscribe from this group, send email to rubyonrails-core+unsubscribe@googlegroups.com. For more options, visit this group at http://groups.google.com/group/rubyonrails-core?hl=en.
On Jan 1, 2013, at 8:08 PM, Ryan Bigg wrote:> I think that this is something that would differ incredibly from app to app. For instance, I would not install Ruby using apt-get myself. > > While I like the idea of having it be a "Getting Started" doc for an app, I don''t think that Rails could come with a cohesive default that would work for everyone. > > -1 to this change.As a more general comment, if something like this was to be added I think it''s important to decide what the expected audience for the README is. For instance, definitions of Rails terms and instructions on how to install Ruby and webservers are probably overkill if the audience is "developers new to the app but not to Rails". One thing that might be useful - somehow hook into the various choices available in `rails new` (test framework, ORM, etc) and include details in the generated file. So for instance, selecting Rspec would produce a paragraph about how to run the specs. --Matt Jones -- You received this message because you are subscribed to the Google Groups "Ruby on Rails: Core" group. To post to this group, send email to rubyonrails-core@googlegroups.com. To unsubscribe from this group, send email to rubyonrails-core+unsubscribe@googlegroups.com. For more options, visit this group at http://groups.google.com/group/rubyonrails-core?hl=en.
Thanks for committing a version of my suggestion. https://github.com/rails/rails/commit/6cf47c533d7d6784d34fc31406a335555e0c32b8#railties/lib/rails/generators/rails/app/templates/README On Sunday, December 16, 2012 5:37:26 AM UTC-8, Xavier Noria wrote:> > You mean to generate this as default doc/README_FOR_APP? >-- You received this message because you are subscribed to the Google Groups "Ruby on Rails: Core" group. To unsubscribe from this group and stop receiving emails from it, send an email to rubyonrails-core+unsubscribe@googlegroups.com. To post to this group, send email to rubyonrails-core@googlegroups.com. Visit this group at http://groups.google.com/group/rubyonrails-core?hl=en. For more options, visit https://groups.google.com/groups/opt_out.