Lighthouse has a new layout. Prefer the old one? Return to the old layout, and switch back any time from the link at the top of each page.

This project is archived and is in readonly mode.

Duplicate README files

#4261

Two README files are almost identical:
diff railties/README railties/lib/rails/generators/rails/app/templates/README

I looked at the one that seemed most recent:
git log -p railties/README | mate

I synced it with railties/lib/rails/generators/rails/app/templates/README and made some minor edits along the way.

Then, I replaced railties/README with a sym link to railties/lib/rails/generators/rails/app/templates/README. So, now there's only one README file. Nice!

I also uppercased ruby where appropriate and deleted double-spaces.

Matt

Reported by Matt Di Pasquale · March 24th, 2010 @ 07:20 AM

State: wontfix
Milestone: none
Assigned to: José Valim José Valim
Importance: Low

Activity

  1. Matt Di Pasquale
    Matt Di Pasquale
    • Assigned user set to Carl Lerche

    March 24th, 2010 @ 07:21 AM

  2. Matt Di Pasquale
    Matt Di Pasquale
    • Tag changed from patch to minor, patch, readme, typo

    March 24th, 2010 @ 07:22 AM

  3. Chad Woolley
    Chad Woolley

    You probably don't want a symlink, that's not cross platform.

    Doesn't make sense to duplicate them though. One is a template, and the other is a "real" one (for developers?). I think it is fine to just resubmit your patch with no symlink and just keep the generator. People hacking in rails shouldn't need it, and there's many other better resources.

    March 24th, 2010 @ 08:29 AM

  4. José Valim
    José Valim
    • State changed from new to wontfix

    Yup, Symlink is a bad idea. There is a rake task to synchronize both READMEs.

    March 26th, 2010 @ 12:21 AM

  5. Matt Di Pasquale
    Matt Di Pasquale
    • Assigned user changed from Carl Lerche to José Valim

    Okay, I attached a new patch file with the symlink deleted and some other minor changes.
    If you'd like to apply all the changes I made to the README file in one commit, I also attached a README.diff file with all the differences.

    José, what's the rake task to synchronize both READMEs? Also, why have two READMEs?

    March 27th, 2010 @ 02:33 PM