Readme necə yazılır

Müəllif: Carl Weaver
Yaradılış Tarixi: 22 Fevral 2021
YeniləMə Tarixi: 28 İyun 2024
Anonim
Next Level GitHub Profile README (NEW) | How To Create An Amazing Profile ReadMe With GitHub Actions
Videonuz: Next Level GitHub Profile README (NEW) | How To Create An Amazing Profile ReadMe With GitHub Actions

MəZmun

Readme faylı ümumiyyətlə bir proqrama daxil olan kiçik bir sənəddir. Readme faylları proqram təminatçıları tərəfindən yazılır və quraşdırma məlumatları və ya sistem parametrləri, əlaqə məlumatları, lisenziya, təriflər və proqram versiyası məlumatları üçün bir bələdçi daxil olmaqla bir proqram haqqında əsas məlumatları ehtiva edir. Proqram paylanması üçün Readme faylının necə yazılacağını bilmək vacibdir. Zəif yazılmış Readme istifadəçini sinir bozucu və yorucu ola bilər, yaxşı bir proqram proqramınız haqqında əsas məlumatları asanlıqla öyrənməyə kömək edə bilər.

Addımlar

  1. 1 Əlaqə məlumatlarını daxil edin. Bu, yəqin ki, Readme sənədinin ən vacib hissəsidir. Əlaqə məlumatları istifadəçiyə proqramı tamamlamağı, bir sual verməyi, bir səhv düzəltməyi və ya proqram üçün ödəniş etməyi təklif etmək üçün sizinlə əlaqə saxlamağa imkan verəcək. Şirkətin adını, veb saytını, e -poçtunu və telefon nömrəsini daxil edin (bu məlumatlar bir neçə sətirdən ibarət olacaq).
    • Şəkildə bir nümunə göstərilmişdir.
  2. 2 Tarixi Readme -ə daxil edin. Bu kiçik, lakin çox vacib bir addımdır. Proqramınızın yayılma tarixini qeyd etmək vacibdir. Bu yolla, istifadəçilər proqram versiyası yeniləmələrindən xəbərdar olacaq və hələ də dəstəkləndiyini müəyyən edə biləcəklər.
  3. 3 Proqramın adını, versiyasını və qiymət məlumatlarını qeyd edin. Üst hissədə tətbiqin adını və versiya nömrəsini yazın. Tam versiyanın qiymətini aşağıda yazın. Proqramı CD kimi fiziki vasitələrdən istifadə edərək paylasanız, istifadəçilər ehtimal ki proqram üçün artıq pul ödədikləri üçün qiymət məlumatlarını daxil edə bilməzsiniz.
  4. 4 Proqramı qısaca təsvir edin. Bir və ya iki cümlə ilə proqramınızın qısa təsvirini verin. Məsələn: "Bu tətbiq istifadəçinin İnternetdəki fəaliyyətini təhlil edərək onun əhvalını izləyir və sonra istifadəçinin emosional vəziyyətinə uyğunlaşmaq üçün masaüstündəki məkanı dəyişir."
    • Proqramınız kifayət qədər geniş xüsusiyyətlərə malikdirsə, təsviri bir və ya iki paraqraf uzada bilərsiniz. Proqramın bütün funksiyalarını və xüsusiyyətlərini saymaq üçün işarələnmiş siyahıdan istifadə edə bilərsiniz.
  5. 5 Proqram üçün minimum tələbləri təsvir edin. Yaxşı bir Readme faylı, proqram üçün minimum tələblər və quraşdırma təlimatları ilə bağlı məlumatları ehtiva etməlidir. Proqramı qurmaq üçün başqa bir proqrama ehtiyacınız varsa, bunu qeyd etməyi unutmayın. Tövsiyə olunan tələblər haqqında məlumatları da əlavə edə bilərsiniz (məsələn, CPU yükü).
  6. 6 Lisenziya və müəllif hüquqları məlumatlarını daxil edin. Sonda, müəlliflik hüququnun qurulduğu tarix və proqramın lisenziyalaşdırılması haqqında məlumat daxil etməyi unutmayın.

İpuçları

  • İstifadəçilərin faylınızı formatlamasının qarşısını almaq üçün onu düz mətn (.txt) formatında saxlayın.
  • Readme faylının adına proqramın adını daxil edin; beləliklə, istifadəçi proqram adı ilə Readme faylını axtaracaq.

Sənə nə lazımdır

  • Kompüter
  • Mətn redaktoru