question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Do not rename existing README, rename the CRA README

See original GitHub issue

I would like to propose that instead of renaming existing README.md to README.old.md if any, CRA should instead leave that file alone and drop its readme under the name README-CRA.md and not README.md.

The rationale for this is that if a readme exists already, it’s most likely going to be more valuable than the CRA readme and that’s what people should keep seeing after CRA is scaffolded in the repository. It’s still handy to have the CRA readme handy, but no one is going to start rebuilding their existing readme on top the CRA one, they will just reference bits of the CRA one in their own.

So instead of forcing people to rename the CRA readme and fixing the incorrect rename of their already existing readme, let’s create the CRA readme under a new name and respect the exsting readme.

Issue Analytics

  • State:open
  • Created 5 years ago
  • Reactions:2
  • Comments:7 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
stale[bot]commented, May 12, 2019

This issue has been automatically marked as stale because it has not had any recent activity. It will be closed in 5 days if no further activity occurs.

1reaction
stale[bot]commented, Apr 3, 2019

This issue has been automatically marked as stale because it has not had any recent activity. It will be closed in 5 days if no further activity occurs.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Rename README.md to custom name and use as a project ...
I would like to change the default project description file name (called README.md ) to be a custom name (let's say XXX.md )...
Read more >
Using Sass with Create React App V1 (Without Ejecting)
One thing you can't do easily, is change the configuration of CRA. That is by design. Essentially the team has decided on a...
Read more >
README File – Everything you Need to Know - Great Learning
A README file is a text file that describes and launches a project. It comprises information that is frequently needed to grasp the...
Read more >
IBM Readme for IBM WebSphere MQ for HP NonStop Server ...
This release notes file contains information that was not available in time for our publications. In addition to this file, README,
Read more >
Fix Create-React-App Showing README.md - Pluralsight
The reason why you see your README.md file being rendered instead of your app is because you have not generated the browser-friendly static ......
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found