search for: readme_for_app

...#39;' $ rake --trace --verbose reappdoc (in /home/radek/src/firma/giga-net/ncc/work) ** Invoke reappdoc (first_time) ** Invoke clobber_appdoc (first_time) ** Execute clobber_appdoc rm -r doc/app rm -r doc/app ** Invoke appdoc (first_time) ** Invoke doc/app/index.html (first_time) ** Invoke doc/README_FOR_APP (first_time, not_needed) ** Invoke app/controllers/application.rb (first_time, not_needed) ** Invoke app/helpers/application_helper.rb (first_time, not_needed) ** Invoke Rakefile (first_time, not_needed) ** Invoke TODO.rd (first_time, not_needed) ** Execute doc/app/index.html rm -r doc/app unrecog...

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

...<< ''--inline-source'' if ENV[''template''] puts "using template: #{ENV[''template'']}" rdoc.options << "--template=#{ENV[''template'']}" end rdoc.rdoc_files.include(''doc/README_FOR_APP'') rdoc.rdoc_files.include(''app/**/*.rb'') rdoc.rdoc_files.include(''lib/**/*.rb'') rdoc.rdoc_files.include(''vendor/plugins/**/*.rb'') rdoc.rdoc_files.include(''test/**/*.rb'') rdoc.rdoc_files.exclude('...

...r the application" -Rake::RDocTask.new("appdoc") { |rdoc| - rdoc.rdoc_dir = ''doc/app'' - rdoc.title = "Rails Application Documentation" - rdoc.options << ''--line-numbers --inline-source'' - rdoc.rdoc_files.include(''doc/README_FOR_APP'') - rdoc.rdoc_files.include(''app/**/*.rb'') -} +task :appdoc do + require ''rdoc/rdoc'' + opt = [''-odoc/app'', ''--line-numbers'', ''--inline-source'', ''-Thtml''] + [''doc/README_...

...t a Fedora thing but it would be nice to generate my application''s API $ rake doc:app --trace (in /home/storage/users/craig/svn/th-db/branches/phase5) ** Invoke doc:app (first_time) ** Invoke doc/app/index.html (first_time) rake aborted! Don''t know how to build task ''doc/README_FOR_APP'' /usr/lib/ruby/gems/1.8/gems/rake-0.8.1/lib/rake.rb:1634:in `[]'' /usr/lib/ruby/gems/1.8/gems/rake-0.8.1/lib/rake.rb:516:in `invoke_prerequisites'' /usr/lib/ruby/gems/1.8/gems/rake-0.8.1/lib/rake.rb:1183:in `each'' /usr/lib/ruby/gems/1.8/gems/rake-0.8.1/lib/rake.rb:...

...on it so I hesitate to do it again... http://wrath.rubyonrails.org/pipermail/rails/2006-February/020413.html [craig@srv2 th-db]$ ls -l doc total 24 drwxr-xr-x 3 craig craig 4096 Feb 23 20:55 plugins drwxr-xr-x 4 craig craig 4096 Feb 19 20:59 rdoccd-bak -rw-rw-r-- 1 craig craig 188 Jan 19 15:51 README_FOR_APP where doc/rdoccd-bak is a folder that used to be app/rdoccd that I moved just in case but is evidence that the rake appdoc actually worked once...4 days ago. Help Craig

...blic/robots.txt create public/images/rails.png create public/javascripts/prototype.js create public/javascripts/effects.js create public/javascripts/dragdrop.js create public/javascripts/controls.js create public/javascripts/application.js create doc/README_FOR_APP create log/server.log create log/production.log create log/development.log create log/test.log C:\tmp\rubyWork>move database.yml app\config Overwrite C:\tmp\rubyWork\app\config\database.yml? (Yes/No/All): yes C:\tmp\rubyWork>ruby app\script\generate scaffold Foo...

...eate config/initializers/secret_token.rb create config/initializers/session_store.rb create config/locales create config/locales/en.yml create config/boot.rb create config/database.yml create db create db/seeds.rb create doc create doc/README_FOR_APP create lib create lib/tasks create lib/tasks/.gitkeep create log create log/server.log create log/production.log create log/development.log create log/test.log create public create public/404.html create public/422.html...

...39;' rake aborted! exit (See full trace by running task with --trace) What is this about? Craig the full trace below if it helps... [craig@srv2 rdoccd]$ rake appdoc --trace (in /home/craig/ruby-db/th-db) ** Invoke appdoc (first_time) ** Invoke doc/app/index.html (first_time) ** Invoke doc/README_FOR_APP (first_time, not_needed) ** Invoke app/models/client.rb (first_time, not_needed) ** Invoke app/models/placement-safe.rb (first_time, not_needed) ** Invoke app/models/case_manager.rb (first_time, not_needed) ** Invoke app/models/client-bak.rb (first_time, not_needed) ** Invoke app/models/facility.rb...

I''ve whipped together this Emacs mode for editing rdoc files. It''s based off of generic-mode. I''ve set it to be active when you open README_FOR_APP or any .rdoc file. Share and enjoy. Jim -- Jim Menard, jim@io.com, jim.menard@gmail.com http://www.io.com/~jimm -------------- next part -------------- A non-text attachment was scrubbed... Name: rdoc-mode.el Type: application/octet-stream Size: 1136 bytes Desc: not available Url : http://wrath.r...

I''ve whipped together this Emacs mode for editing rdoc files. It''s based off of generic-mode. I''ve set it to be active when you open README_FOR_APP or any .rdoc file. Share and enjoy. Jim -- Jim Menard, jim@io.com, jim.menard@gmail.com http://www.io.com/~jimm -------------- next part -------------- A non-text attachment was scrubbed... Name: rdoc-mode.el Type: application/octet-stream Size: 1132 bytes Desc: not available Url : http://wrath.r...

I would like to include other documents in the doc directory in my documentation, most likely linked from the README_FOR_APP. Is there an easy way to say "in addition to my app, rdoc everything in doc/*". -Kelly -------------- next part -------------- An HTML attachment was scrubbed... URL: http://wrath.rubyonrails.org/pipermail/rails/attachments/20060111/792f1361/attachment.html

...e the -T option). So, where do I point my browser to (so that I can view the new generated application documentation)? Running gem_server didn''t help so far... listing doc.bat rdoc -o doc/app --line-numbers --inline-source --title ''Rails Application Documentation'' doc/README_FOR_APP app/controllers/admin_controller.rb app/controllers/application.rb app/controllers/login_controller.rb app/controllers/store_controller.rb app/helpers/admin_helper.rb app/helpers/application_helper.rb app/helpers/login_helper.rb app/helpers/store_helper.rb app/models/cart.rb app/models/li...

...blic/robots.txt create public/images/rails.png create public/javascripts/prototype.js create public/javascripts/effects.js create public/javascripts/dragdrop.js create public/javascripts/controls.js create public/javascripts/application.js create doc/README_FOR_APP create log/server.log create log/production.log create log/development.log create log/test.log [renat@localhost rails]$ cd mysite [renat@localhost mysite]$ ruby script/server /home/renat/.gem/ruby/1.9.1/gems/activesupport-2.2.2/lib/active_support/dependencies.rb:153:in `...

...e config/initializers/session_store.rb create config/initializers/wrap_parameters.rb create config/locales create config/locales/en.yml create config/boot.rb create config/database.yml create db create db/seeds.rb create doc create doc/README_FOR_APP create lib create lib/tasks create lib/tasks/.gitkeep create lib/assets create lib/assets/.gitkeep create log create log/.gitkeep create public create public/404.html create public/422.html create public/500.html cre...

...create public/favicon.ico create public/robots.txt create public/images/rails.png create public/javascripts/prototype.js create public/javascripts/effects.js create public/javascripts/dragdrop.js create public/javascripts/controls.js create doc/README_FOR_APP create log/server.log create log/production.log create log/development.log create log/test.log %cd testapp %ruby script/server => Booting WEBrick... => Rails application started on http://0.0.0.0:3000 => Ctrl-C to shutdown server; call with --help for options --...

...blic/robots.txt create public/images/rails.png create public/javascripts/prototype.js create public/javascripts/effects.js create public/javascripts/dragdrop.js create public/javascripts/controls.js create public/javascripts/application.js create doc/README_FOR_APP create log/server.log create log/production.log create log/development.log create log/test.log C:\Downloads\Ruby on Rails\rubygems-1.3.5\rubygems-1.3.5>cd c:\program files\apa che*\apache*\htdocs\rails C:\Program Files\Apache Software Foundation\Apache2.2\htdocs \r...