Basically the idea is to be able to mark files in your package as “readme” files. This indicates that the package developer feels that the package consumer should read/modify the files before using the package.
What will happen with such marked files is dependent on the client/context in which the package is installed:
- When installed inside VS the readme files would automatically be opened. This is modeled after the VS project template feature that allows some files to be automatically opened in the editor after the project is created.
When installed outside VS the runner could either open them with notepad.exe (or maybe the defautl system text editor, so that this also works in a Mono environment) or to keep things simpler, simply print a message “Package A indicates that you should look at file Readme.txt first”.
This feature could be useful for:
- Simple Readme.text files
- Configuration files (such as .config or maybe even configuration source files - for example useful for an MVC pacakage that adds some custom routes via a source file)
- Other instructions about manual steps necessary to activate the package