הצגת המקור של הדף "README"

[[קובץ:README-cURL_black_trimmed.png|ממוזער| צילום מסך של קובץ README של [[cURL]]]]
ב[[פיתוח תוכנה]], [[קובץ]] '''README''' הוא קובץ המכיל מידע על הקבצים האחרים [[תיקיית קבצים|בספרייה]] או בארכיון של [[תוכנה|תוכנת]] מחשב. זה בדרך כלל מדובר בקובץ טקסט פשוט שנקרא<code>README</code>, <code>Read Me</code>, <code>READ.ME</code>, <code>README.TXT</code>, <code>README.md</code> (כדי לציין את השימוש ב- Markdown ), או <code>README.1ST</code> .

שם הקובץ כתוב בדרך כלל באותיות גדולות. [[מערכת הפעלה דמוית יוניקס|במערכות דמויות יוניקס]] במיוחד, זה גורם לקובץ לבלוט – הן בגלל ששמות קבצים קטנים יותר נפוצים, והן בגלל שהפקודה [[Ls|<code>ls</code>]] בדרך כלל ממיינת ומציגה קבצים [[ASCII|בסדר קוד ASCII]], שבו שמות קבצים עם אותיות גדולות יופיעו תחילה.

משמעות שם הקובץ בעברית הוא "קרא אותי".

== תוכן ==
קובץ README כולל בדרך כלל:
* הוראות הגדרה
* הוראות [[התקנת תוכנה|התקנה]]
* הוראות הפעלה
* [[קובץ מניפסט|מניפסט]] קובץ (רשימת קבצים בספרייה או בארכיון)
* מידע על [[זכויות יוצרים]] [[רישיון תוכנה|ורישוי]]
* פרטי התקשרות של המפיץ או המחבר
* רשימה של [[באג]]ים ידועים
* הוראות [[טראבל שוטינג|לפתרון בעיות]]
* [[קרדיט (יצירה)|קרדיטים]] ותודות
* יומן שינויים (בדרך כלל מיועד למתכנתים אחרים)
* מדור חדשות (בדרך כלל מיועד [[משתמש קצה|למשתמשי קצה]])

== היסטוריה ==
 לא ברור מתי החלה החלה הכללת קובץ README, אך נמצאו דוגמאות המתוארכות לאמצע שנות ה-70. מערכת [[Mac OS Classic|מקינטוש]] מוקדמת התקינה קובץ README בכונן האתחול, וקובצי README נלוו בדרך כלל לתוכנות צד שלישי.

בפרט, ל[[תוכנה חופשית|תוכנות חופשיות ותוכנות]] [[קוד פתוח]] יש היסטוריה ארוכה של הוספת קובץ README; תקני הקידוד של GNU מעודדים לכלול את הקובץ כדי לספק "סקירה כללית של החבילה".

מאז הופעת [[World Wide Web|האינטרנט]] כפלטפורמה סטנדרטית [[דה פקטו]] להפצת תוכנה, חבילות תוכנה רבות העבירו חלק מהקבצים הנלווים ופיסות המידע לעיל לאתר [[אתר אינטרנט|אינטרנט]] או [[ויקי]], לפעמים כולל את קובץ ה-README עצמו, או השאירו מאחור רק קובץ README קצר ללא כל המידע הנדרש למשתמש חדש בתוכנה.

אתר האינטרנט הפופולרי לאירוח [[קוד מקור]], [[GitHub]] מעודד מאוד יצירת קובץ README – אם אחד כזה קיים בספרייה הראשית (ברמה העליונה) של מאגר, הוא מוצג אוטומטית בעמוד הראשון של המאגר. בנוסף לטקסט רגיל, נתמכים גם פורמטים ו[[סיומת קובץ|סיומות קבצים]] שונים.

== כמונח כללי ==
הביטוי "קובץ readme" משמש לעיתים גם באופן כללי, עבור קבצים אחרים עם מטרה דומה.{{מקור|נושא=מחשוב}} לדוגמה, הפצות קוד המקור של חבילות תוכנה חינמיות רבות (במיוחד אלו העוקבות אחר תקני Gnits או אלו המיוצרות עם הכלים האוטומטיים של GNU) כוללות סט סטנדרטי של קובצי readme:
{| class="wikitable"
|<code>README</code>
|מידע כללי
|-
|<code>AUTHORS</code>
|קרדיטים
|-
|<code>THANKS</code>
|תודות
|-
|<code>[[:en:Changelog|CHANGELOG]]</code>
|יומן שינויים מפורט, מיועד למתכנתים
|-
|<code>NEWS</code>
|יומן שינויים בסיסי, מיועד למשתמשים
|-
|<code>INSTALL</code>
|הוראות התקנה
|-
|<code>COPYING</code> <nowiki>/</nowiki> <code>LICENSE</code>
|מידע על זכויות יוצרים ורישוי
|-
|<code>BUGS</code>
|באגים ידועים והוראות לדיווח על באגים חדשים
|-
|<code>CONTRIBUTING</code> <nowiki>/</nowiki> <code>HACKING</code>
|מדריך לתרומה לפרויקט
|}
כמו כן בדרך כלל מופץ עם חבילות תוכנה קובץ שאלות נפוצות וקובץ <code>TODO</code>, המפרט שיפורים מתוכננים.

== לקריאה נוספת ==
* {{Cite journal|date=1997-02-01|title=Building a Better ReadMe|journal=[[Technical Communication (journal)|Technical Communication]]|publisher=[[Society for Technical Communication]]|volume=44|issue=1|pages=28–36|jstor=43089849}} [https://www.researchgate.net/publication/233611803_Building_a_Better_ReadMe][http://www.ingentaconnect.com/content/stc/tc/1997/00000044/00000001/art00004]
* {{Cite journal|date=August 1997|title=Hypertext good choice for README files|journal=[[Technical Communication (journal)|Technical Communication]]|publisher=[[Society for Technical Communication]]|volume=44|issue=3|page=214|jstor=43089876}}
* [https://books.google.com/books?id=vFEEAAAAMBAJ&pg=PA34&lpg=PA34]
* {{Cite journal|author-link=Andrew Benjamin|date=1996-09-15|editor-last=Guédon|editor-first=Jean-Claude|editor-link=Jean-Claude Guédon|title=Readme: Writing Notes - Meditations on the temporality of writing|url=https://www.pum.umontreal.ca/revues/surfaces/vol3/benjami.html|url-status=live|journal=[[Surfaces (Université de Montréal journal)|Surfaces]]|type=Electronic journal|language=en, fr|location=Department of Philosophy, [[University of Warwick]], UK|publisher=[[Les Presses de l'Université de Montréal]]|publication-place=[[Université de Montréal]], Montreal (Quebec), Canada|volume=III|issue=12|pages=1–12|issn=1188-2492|archive-url=https://web.archive.org/web/20060220060754/https://www.pum.umontreal.ca/revues/surfaces/vol3/benjami.html|archive-date=2006-02-20|access-date=4 June 2019}} [https://www.pum.umontreal.ca/revues/surfaces/sgml/vol3/benjami.sgml]
[[קטגוריה:תיעוד]]
[[קטגוריה:תוכנה]]