Github README.md में क्या जानकारी होनी चाहिए?

Question

क्या जानकारी आपको github README में देखने की उम्मीद है?

क्या README में सब कुछ जाना चाहिए? अर्थात

• परिचय

• स्थापना

• संस्करण

• उपयोगकर्ता गाइड

• कार्यान्वयन

• परिक्षण

• संबंधित संसाधन

या क्या आपको आरईएडीएमई (परिचय, स्थापना, संस्करण) में कुछ चीजें डालनी चाहिए और अन्य जानकारी को गिथुबिकी में रखा जाना चाहिए?

Comments

मैं लाइसेंस की शर्तें भी

— रखूंगा

सामान्य रूप से सामान्य शब्दों में, मुझे यह बताने के लिए पर्याप्त जानकारी होनी चाहिए कि क्या परियोजना मेरे लिए उपयोगी है, अगर मुझे इसके बारे में पता है तो यह नाम है। पाठक को कैसे मिला, इसके बारे में कुछ भी मत समझो।

— कीथ थॉम्पसन

इस सवाल का यहाँ बहुत विस्तृत / अच्छा जवाब है: stackoverflow.com/questions/2304863/how-to-write-a-good-readme

— Rodrigo Graça

Answer 1

मुझे एक परिचय और संक्षिप्त अवलोकन देखने की उम्मीद है। मुझे समझाने के लिए वहां कुछ होना चाहिए कि परियोजना एक विशेष समस्या को हल करती है। README को पढ़ने के बाद, मुझे यह जानने के लिए पर्याप्त जानकारी होनी चाहिए कि परियोजना क्या करती है, इसकी क्या आवश्यकता है, इसे कैसे बनाना है, और इसका उपयोग कैसे करना है। उस जानकारी को README में होना आवश्यक नहीं है, लेकिन उस जानकारी के लिंक होने चाहिए।

Comments

संक्षिप्त के लिए +1। "README" मत कहो और फिर कचरे का एक गुच्छा रखो जिसमें पढ़ने की आवश्यकता नहीं है।

— कोरी हिन्टन