ວິທີການຂຽນ Readme

ກະວີ: Carl Weaver
ວັນທີຂອງການສ້າງ: 22 ກຸມພາ 2021
ວັນທີປັບປຸງ: 26 ມິຖຸນາ 2024
Anonim
ວິທີການຂຽນ Readme - ສະມາຄົມ
ວິທີການຂຽນ Readme - ສະມາຄົມ

ເນື້ອຫາ

ໄຟລ Read Readme ເປັນເອກະສານນ້ອຍ small ທີ່ໂດຍປົກກະຕິແລ້ວຈະລວມຢູ່ໃນໂປຣແກຣມ. ໄຟລ Read Readme ຖືກຂຽນໂດຍນັກພັດທະນາຊອບແວແລະບັນຈຸຂໍ້ມູນພື້ນຖານກ່ຽວກັບໂປຣແກມ, ລວມທັງຂໍ້ມູນການຕິດຕັ້ງຫຼືຄໍາແນະນໍາການຕັ້ງຄ່າລະບົບ, ຂໍ້ມູນຕິດຕໍ່, ໃບອະນຸຍາດ, ຄໍາຊົມເຊີຍ, ແລະຂໍ້ມູນເວີຊັນຊອບແວ. ສໍາລັບການແຈກຢາຍຊອບແວ, ມັນເປັນສິ່ງສໍາຄັນທີ່ຈະຮູ້ວິທີຂຽນໄຟລ Read Readme. ການອ່ານທີ່ຂຽນບໍ່ດີສາມາດເຮັດໃຫ້ຜູ້ໃຊ້ອຸກອັ່ງແລະເປັນຕາເບື່ອ, ໃນຂະນະທີ່ອັນທີ່ດີສາມາດຊ່ວຍເຂົາເຈົ້າຮຽນຮູ້ຂໍ້ມູນພື້ນຖານກ່ຽວກັບໂປຣແກມຂອງເຈົ້າໄດ້ງ່າຍ.

ຂັ້ນຕອນ

  1. 1 ລວມເອົາຂໍ້ມູນການຕິດຕໍ່. ອັນນີ້ອາດຈະເປັນພາກສ່ວນທີ່ສໍາຄັນທີ່ສຸດຂອງເອກະສານ Readme. ຂໍ້ມູນການຕິດຕໍ່ຈະອະນຸຍາດໃຫ້ຜູ້ໃຊ້ຕິດຕໍ່ຫາເຈົ້າເພື່ອແນະນໍາໃຫ້ເຈົ້າເສີມໂປຣແກມ, ຖາມຄໍາຖາມ, ແກ້ໄຂຂໍ້ຜິດພາດຫຼືຊໍາລະຄ່າໂຄງການ. ລວມເອົາຊື່ບໍລິສັດ, ເວັບໄຊທ,, ອີເມລ number ແລະເບີໂທລະສັບ (ຂໍ້ມູນນີ້ຈະໃຊ້ເວລາສອງສາມແຖວ).
    • ຕົວຢ່າງແມ່ນສະແດງຢູ່ໃນຮູບ.
  2. 2 ໃສ່ວັນທີໃສ່ໃນ Readme ຂອງເຈົ້າ. ອັນນີ້ແມ່ນບາດກ້າວນ້ອຍ small ແຕ່ສໍາຄັນຫຼາຍ. ມັນເປັນສິ່ງ ສຳ ຄັນທີ່ຈະdateາຍວັນທີແຈກຢາຍ ສຳ ລັບໂປຼແກຼມຂອງເຈົ້າ. ວິທີນີ້, ຜູ້ໃຊ້ຈະຮັບຮູ້ການອັບເດດເວີຊັນຂອງໂປຣແກມແລະຍັງຈະສາມາດກໍານົດໄດ້ວ່າມັນຍັງຖືກສະ ໜັບ ສະ ໜູນ ຫຼືບໍ່.
  3. 3 ບັນທຶກຊື່ຂອງໂຄງການ, ລຸ້ນ, ແລະຂໍ້ມູນລາຄາ. ຢູ່ເທິງສຸດ, ຂຽນຊື່ແອັບພລິເຄຊັນແລະversionາຍເລກຮຸ່ນ. ກະລຸນາຂຽນລາຄາ ສຳ ລັບສະບັບເຕັມຢູ່ລຸ່ມນີ້. ຖ້າເຈົ້າແຈກຢາຍໂປຣແກມໂດຍໃຊ້ສື່ທາງກາຍະພາບເຊັ່ນ: CD, ເຈົ້າອາດຈະບໍ່ລວມເອົາຂໍ້ມູນລາຄາເພາະວ່າຜູ້ໃຊ້ອາດຈະໄດ້ຈ່າຍເງິນໃຫ້ກັບໂຄງການແລ້ວ.
  4. 4 ອະທິບາຍໂຄງການໂດຍຫຍໍ້. ໃຫ້ຄໍາອະທິບາຍສັ້ນ of ກ່ຽວກັບໂຄງການຂອງເຈົ້າຢູ່ໃນປະໂຫຍກຫຼືສອງຄໍາ. ຕົວຢ່າງ: "ແອັບພລິເຄຊັນນີ້ຕິດຕາມອາລົມຂອງຜູ້ໃຊ້ໂດຍການວິເຄາະກິດຈະກໍາຂອງລາວຢູ່ໃນອິນເຕີເນັດ, ແລະຈາກນັ້ນປ່ຽນພື້ນທີ່ຢູ່ໃນເດັສທັອບໃນວິທີທາງທີ່ຈະປັບຕົວເຂົ້າກັບສະພາບອາລົມຂອງຜູ້ໃຊ້."
    • ຖ້າຊອບແວຂອງເຈົ້າມີຄຸນສົມບັດທີ່ກວ້າງພໍສົມຄວນ, ເຈົ້າສາມາດຂະຫຍາຍ ຄຳ ອະທິບາຍອອກເປັນວັກທັງorົດຫຼືສອງ ຄຳ. ເຈົ້າສາມາດໃຊ້ບັນຊີລາຍຊື່ຫຍໍ້ ໜ້າ ເພື່ອບອກຕົວເລກທຸກ ໜ້າ ທີ່ແລະລັກສະນະຂອງໂປຣແກມ.
  5. 5 ອະທິບາຍຄວາມຕ້ອງການຂັ້ນຕ່ ຳ ສຸດຂອງໂຄງການ. ໄຟລ Read Readme ທີ່ດີຄວນມີຂໍ້ມູນກ່ຽວກັບຄວາມຕ້ອງການຂັ້ນຕ່ ຳ ສຸດສໍາລັບໂປຣແກມແລະຄໍາແນະນໍາການຕິດຕັ້ງ. ຖ້າເຈົ້າຕ້ອງການຊອບແວຊຸດອື່ນເພື່ອຕິດຕັ້ງໂປຣແກມ, ໃຫ້ແນ່ໃຈວ່າໄດ້ກ່າວເຖິງມັນ. ທ່ານຍັງສາມາດລວມເອົາຂໍ້ມູນກ່ຽວກັບຄວາມຕ້ອງການທີ່ແນະນໍາ (ຕົວຢ່າງ, ການໂຫຼດ CPU).
  6. 6 ລວມເອົາຂໍ້ມູນລິຂະສິດແລະລິຂະສິດ. ໃນຕອນທ້າຍ, ຢ່າລືມລວມເອົາຂໍ້ມູນກ່ຽວກັບວັນທີສ້າງຕັ້ງລິຂະສິດແລະການອະນຸຍາດຂອງໂຄງການ.

ຄໍາແນະນໍາ

  • ເພື່ອປ້ອງກັນບໍ່ໃຫ້ຜູ້ໃຊ້ຕ້ອງຈັດຮູບແບບໄຟລ your ຂອງເຈົ້າ, ບັນທຶກມັນໄວ້ໃນຮູບແບບຂໍ້ຄວາມທໍາມະດາ (.txt).
  • ໃນຊື່ຂອງໄຟລ Read Readme, ລວມເອົາຊື່ຂອງໂປຣແກມ; ດັ່ງນັ້ນ, ຜູ້ໃຊ້ຈະຄົ້ນຫາໄຟລ Read Readme ຕາມຊື່ຂອງໂຄງການ.

ເຈົ້າ​ຕ້ອງ​ການ​ຫຍັງ

  • ຄອມພິວເຕີ
  • ຕົວແກ້ໄຂຂໍ້ຄວາມ