readme file


Also found in: Dictionary.

README file

(convention)
An introduction traditionally included in the top-level directory of a Unix source distribution, containing a pointer to more detailed documentation, credits, miscellaneous revision history, notes, etc. The file may be named README, or READ.ME, or rarely ReadMe or readme.txt or some other variant.

In the Macintosh and IBM PC worlds, software is not usually distributed in source form, and the README is more likely to contain user-oriented material like last-minute documentation changes, error workarounds, and restrictions.

The README convention probably follows the famous scene in Lewis Carroll's "Alice's Adventures In Wonderland" in which Alice confronts magic munchies labelled "Eat Me" and "Drink Me".

readme file

A text file copied onto software distribution disks that contains last-minute updates or errata that have not been printed in the documentation manual.
Mentioned in ?
References in periodicals archive ?
More requests could provide additional details, such as the readme file for each repository or the user names of those who forked the repository on GitHub.
Where do bots come from? An analysis of bot codes shared on GitHub
The EOL format is an ASCII text format and is described in detail in the readme file on the dataset website.
A long-term, high-quality, high-vertical-resolution GPS dropsonde dataset for hurricane and other studies: a long-term, high-quality, high-vertical-resolution GPS dropsonde dataset is created from NOAA hurricane flights and consists of 13,681 atmospheric profiles for 120 tropical cyclones
This readme file should contain the designer's contact information, including an after-hours phone number, as well as contact info for the person responsible for the parts kit.
Working successfully with your service providers: organization--your own--is the name of the game, when dealing with design, fabrication and assembly service providers
2 Server as well, with the shipping Server CDs being version 6C115a - the only change is a French-language ReadMe file.
bobdotcom: Now would be a good time to update your Mac's security software
This page gives three rules of thumb for obtaining type from Web sources (obtain fonts from the designer, use only fonts with a README file, and shop only on sites where the owners take responsibility for their products).
WebWorks: Typography
The BSP is delivered with complete documentation, including a readme file and an installation guide.
V3 SEMICONDUCTOR DELIVERS LINUX SUPPORT FOR PMC-SIERRA'S MIPS PROCESSORS IN EMBEDDED PCI APPLICATIONS
The Birmingham Poplog directory is at the following location, where the README file lists information about SIM_AGENT and its supporting libraries: ftp://ftp.
Building Cognitively Rich Agents
The ReadMe file is unnecessarily technical, and it actually provides little useful information except possibly the identity of the files (for example, PVEZW32D.
Africa - Folk Music Atlas
A README file that accompanies the software provides a more detailed description of all the routines and parameters.
Algorithm 774: Fortran subroutines for generating box-constrained optimization problems
A README file contains information pertinent to the downloading of the files.
STN Database summary sheets now on the Internet
Instructions in the README file there will lead you through downloading and installing lynx.
Teaching the World Wide Web with a text-based browser - part two
README file detailing sectional additions and changes
Sweet's group distributes enhanced edition of electronic construction product database

Encyclopedia browser ?
Full browser ?