README
בפיתוח תוכנה, קובץ README הוא קובץ המכיל מידע על הקבצים האחרים בספרייה או בארכיון של תוכנת מחשב. זה בדרך כלל מדובר בקובץ טקסט פשוט שנקראREADME, Read Me, READ.ME, README.TXT, README.md (כדי לציין את השימוש ב- Markdown ), או README.1ST .
שם הקובץ כתוב בדרך כלל באותיות גדולות. במערכות דמויות יוניקס במיוחד, זה גורם לה לבלוט – הן בגלל ששמות קבצים קטנים יותר נפוצים, והן בגלל שהפקודה ls בדרך כלל ממיינת ומציגה קבצים בסדר קוד ASCII, שבו שמות קבצים עם אותיות גדולות יופיעו תחילה.
תוכן
קובץ README כולל בדרך כלל:
- הוראות הגדרה
- הוראות התקנה
- הוראות הפעלה
- מניפסט קובץ (רשימת קבצים בספרייה או בארכיון)
- מידע על זכויות יוצרים ורישוי
- פרטי התקשרות של המפיץ או המחבר
- רשימה של באגים ידועים
- הוראות לפתרון בעיות
- קרדיטים ותודות
- יומן שינויים (בדרך כלל מיועד למתכנתים אחרים)
- מדור חדשות (בדרך כלל מיועד למשתמשי קצה)
היסטוריה
לא ברור מתי החלה החלה הכללת קובץ README, אך נמצאו דוגמאות המתוארכות לאמצע שנות ה-70. מערכת מקינטוש מוקדמת התקינה קובץ README בכונן האתחול, וקובצי README נלוו בדרך כלל לתוכנות צד שלישי.
בפרט, לתוכנות חופשיות ותוכנות קוד פתוח יש היסטוריה ארוכה של הוספת קובץ README; תקני הקידוד של GNU מעודדים לכלול את הקובץ כדי לספק "סקירה כללית של החבילה".
מאז הופעת האינטרנט כפלטפורמה סטנדרטית דה פקטו להפצת תוכנה, חבילות תוכנה רבות העבירו חלק מהקבצים הנלווים ופיסות המידע לעיל לאתר אינטרנט או ויקי, לפעמים כולל את קובץ ה-README עצמו, או השאירו מאחור רק קובץ README קצר ללא כל המידע הנדרש למשתמש חדש בתוכנה.
אתר האינטרנט הפופולרי לאירוח קוד מקור, GitHub מעודד מאוד יצירת קובץ README – אם אחד כזה קיים בספרייה הראשית (ברמה העליונה) של מאגר, הוא מוצג אוטומטית בעמוד הראשון של המאגר. בנוסף לטקסט רגיל, נתמכים גם פורמטים וסיומות קבצים שונים.
כמונח כללי
הביטוי "קובץ readme" משמש לעיתים גם באופן כללי, עבור קבצים אחרים עם מטרה דומה.[דרוש מקור] לדוגמה, הפצות קוד המקור של חבילות תוכנה חינמיות רבות (במיוחד אלו העוקבות אחר תקני Gnits או אלו המיוצרות עם הכלים האוטומטיים של GNU) כוללות סט סטנדרטי של קובצי readme:
README
|
מידע כללי |
AUTHORS
|
קרדיטים |
THANKS
|
תודות |
CHANGELOG
|
יומן שינויים מפורט, מיועד למתכנתים |
NEWS
|
יומן שינויים בסיסי, מיועד למשתמשים |
INSTALL
|
הוראות התקנה |
COPYING / LICENSE
|
מידע על זכויות יוצרים ורישוי |
BUGS
|
באגים ידועים והוראות לדיווח על באגים חדשים |
CONTRIBUTING / HACKING
|
מדריך לתרומה לפרויקט |
כמו כן בדרך כלל מופץ עם חבילות תוכנה קובץ שאלות נפוצות וקובץ TODO, המפרט שיפורים מתוכננים.
לקריאה נוספת
- "Building a Better ReadMe". Technical Communication. Society for Technical Communication. 44 (1): 28–36. 1997-02-01. JSTOR 43089849. [1][2]
- "Hypertext good choice for README files". Technical Communication. Society for Technical Communication. 44 (3): 214. באוגוסט 1997. JSTOR 43089876.
{{cite journal}}: (עזרה) - [3]
- Guédon, Jean-Claude, ed. (1996-09-15). Written at Department of Philosophy, University of Warwick, UK. "Readme: Writing Notes - Meditations on the temporality of writing". Surfaces (Electronic journal) (באנגלית and צרפתית). Université de Montréal, Montreal (Quebec), Canada: Les Presses de l'Université de Montréal. III (12): 1–12. ISSN 1188-2492. ארכיון מ-2006-02-20. נבדק ב-4 ביוני 2019.
{{cite journal}}: (עזרה) [4]
35395084README