Readme.md versus replit.md

Agent & Assistant
, , ,
1

Readme files have long been used and are well understood. But then Replit introduced the replit.md file and, in my opinion, have confused everything.

Looking at what Replit’s agent itself adds to a replit.md file, I wonder - why do we need this separate file? Why not just stick with readme.md?

The 2 files that have been written and added to by my agent essentially contain the same information.

Am I missing something? What exactly should each of these 2 files contain?

2

I think I’ve figured it - well in my own head anyway:

  • replit.md is instructions for the agent
  • readme.md is instructions and app info for the user

I still think there will be a lot of overlap though.

1 Like
3

My Agent added a separate readme file for a specific feature in the app - which I found interesting. I agree that the readme appears to be for the app developer as it contains instructions on how I can manually run data refreshes in my case.

1 Like