readme

How do I get the Mac OS X 'quick look' feature to be more programmer-friendly?

There are numerous text files that are always included in common downloads such as rails plugins: LICENSE, ChangeLog, Rakefile, etc. I know these files are plain-text, but Mac OS X refuses to acknowledge this automatically. If I hit the spacebar in Finder to activate "quick look", the icon becomes huge but the contents of the file are n...

Displaying instructions to user after .deb installer completes

Is there a commonly used approach for displaying 'how to get started' instructions to a user after a .deb installer has finished installing a package? I need an approach that works for users working via a terminal as well as from a desktop environment. Server admins will probably know to check for a README file but many others won't....

How to write a good README

I guess everyone has seen a README file, but I would like the definitive guide on how to write an excellent README file with the least amount of energy spent on it. What's a README file? What should I write in it? How exactly should I format it? ...

Adding option to view readme file on the final screen of visual studio deployment project

I've got a visual studio deployment project and would like to add an option to view a readme file from the final screen. So basically there would be a link or checkbox that the user can select if they want to view the readme. Does anyone know of an easy way to do this? ...