readme
Software's introductory file
A readme is a text file included with software that provides essential information about the program—installation instructions, usage guidelines, known issues, or licensing terms.
The name comes from its implicit instruction to the user: read me first.
In open-source projects, the readme often serves as the main documentation: Check the readme for setup instructions.
Guidance on how to proceed
- how-toPractical instruction format
- tutorialInstructional step-by-step guide
- walkthroughSequential instructional guide
- stepsSequential actions in process
directions · guide · primer · troubleshooting · faq · tips · examples · reference
Stored collection of data
- textWritten or printed words
- markdownReduction in retail price
- repositoryPlace for storing things
- gitBritish term for fool
open-source · project · codebase · license · changelog · contributing · badges · formatting
Broad general summary
- introductionPreliminary section or presentation
- descriptionAccount of characteristics
- purposeReason something exists
- aboutConcerning or approximately
contents · sections · features · highlights · synopsis · summary · background · context
Process of putting in
- configurationArrangement of parts
- setupHow something is arranged
- requirementsNecessary conditions for something
- dependenciesThings required for operation
prerequisites · quickstart · environment · initialization · deployment · usage · commands · examples
instructions
Guidance on how to proceed
- how-toPractical instruction format
- tutorialInstructional step-by-step guide
- walkthroughSequential instructional guide
steps · directions · guide · primer · troubleshooting · faq · tips · examples · reference · documentation
file
Stored collection of data
- textWritten or printed words
- markdownReduction in retail price
- repositoryPlace for storing things
git · open-source · project · codebase · license · changelog · contributing · badges · formatting · preview
overview
Broad general summary
- introductionPreliminary section or presentation
- descriptionAccount of characteristics
- purposeReason something exists
about · contents · sections · features · highlights · synopsis · summary · background · context · specifications
installation
Process of putting in
- configurationArrangement of parts
- setupHow something is arranged
- requirementsNecessary conditions for something
dependencies · prerequisites · quickstart · environment · initialization · deployment · usage · commands · examples · parameters
- dev culturedebug, bug, code review, pull request, git
- textplain text, plaintext, text file, text editor, words
- getting startedgetting started, start, begin, first steps, basics
- Introductory Materialssyllabus, handbook, primer, overview, welcome packet
- documentationmanual, manuals, user guide, user guides, user manual
- fichierstxt, pdf, doc, mp3, zip
readmesource code
Programming instructions before compilation
executable · binary · script · compiled code · bytecode
- reads mindsPerceives others' thoughts directly
- mind readerOne who perceives thoughts
- reading aloudSpeaking text for listeners
- reading glassesCorrective lenses for close-up
- mind readingPerceiving others' thoughts directly
- read aloudSpeak written words
read, reading, reader, reads, unread, misread, readable, proofread, preadmission