README
Project's front page
A README is a text file included with software or code repositories that explains what the project does, how to install it, and how to use it.
The name literally instructs: read me first.
READMEs serve as the entry point for anyone encountering unfamiliar code: Check the README for setup instructions.
The format has become standard in open-source development, typically written in plain text or Markdown.
Stored collection of data
- documentationWritten proof or instructions
- instructionsGuidance on how to proceed
- guideLeader or instruction book
- overviewBroad general summary
introduction · markdown · repository · project · description · installation · usage · license
Web-based code hosting service
- repositoryPlace for storing things
- codebaseSoftware project's complete source
- open-sourceFreely viewable, editable code
- cloneGenetically identical organism
fork · commit · version · release · developer · maintainer · contributor · package
file
Stored collection of data
- documentationWritten proof or instructions
- instructionsGuidance on how to proceed
- guideLeader or instruction book
overview · introduction · markdown · repository · project · description · installation · usage · license · contributing
GitHub
Web-based code hosting service
- repositoryPlace for storing things
- codebaseSoftware project's complete source
- open-sourceFreely viewable, editable code
clone · fork · commit · version · release · developer · maintainer · contributor · package · library
markdown
Reduction in retail price
- plaintextUnencoded readable information
- HTMLWeb page code
- renderingInterpretive depiction or performance
preview · formatting · headings · bullets · links · images · tables · syntax · extension · editor
- codefunction, source code, variable, array, class
- code documentationcomment, note, explanation, clarification, rationale
- open sourceGNU, open source software, free software, GPL, forks
- API documentationendpoints, parameters, requests, responses, methods
READMEsource code
Programming instructions before compilation
executable · binary · code · compiled code · script
- 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, reads, reader, readers, reading, readings, readable, unreadable, readability