Don't automatically add README to existing apps

I just noticed that Anvil will keep trying to create a README in existing apps if there is none present. I think it’s a great idea to include a README in new apps, but I don’t think it’s a good practice to automatically add a README to existing apps, and especially not to force it back in it after I have explicitly deleted it. I might have good reasons for not wanting to include a README.

Is the app in which you are seeing this synced with GitHub via Anvil, or no?

In my case, it’s not synced with GitHub, just my desktop Git repo. And yes, I received a README.md file.

1 Like

Ah - apologies! In this case the auto-readme-adder (in fact the auto-file-adder; it’s the same thing that creates the automatic __init__.py to make local-server launches easier) can’t actually tell the difference between “an app with a deleted README” and “an old app to which the README has not yet been added”.

Can I suggest creating an empty file called README.md instead? If the file exists and doesn’t have the default contents, Anvil knows not to edit it.

1 Like

Yes, that’s what I did. It’s not a major deal, to be fair.

1 Like