A repo readme should mostly explain what the application is and a summary of how to use it, in simple terms - "accepts a POST request from a form and emails the contents to a configurable email address", explain that this is a WSGI app that can be deployed using your favorite WSGI server (maybe quick manual deploy instructions), and then optionally include the local install directions as "how to set up a dev instance"
Kennric
commented
9 years ago
A repo readme should mostly explain what the application is and a summary of how to use it, in simple terms - "accepts a POST request from a form and emails the contents to a configurable email address", explain that this is a WSGI app that can be deployed using your favorite WSGI server (maybe quick manual deploy instructions), and then optionally include the local install directions as "how to set up a dev instance"