GitHub README जनरेटर
अपने GitHub प्रोजेक्ट के लिए प्रोफ़ेशनल README.md बनाएँ: बैज, परिचय, फ़ीचर, टेक स्टैक, इंस्टॉल, इस्तेमाल, एनवायरनमेंट, रोडमैप, योगदान, लाइसेंस और लेखक।
GitHub README जनरेटर लोड हो रहा है…
आपकी फ़ाइलें कभी आपके डिवाइस से बाहर नहीं जातीं
GitHub README जनरेटर का इस्तेमाल कैसे करें
- 1
इस पेज पर GitHub README जनरेटर खोलें। यह सीधे आपके ब्राउज़र में लोड होता है।
- 2
अपनी फ़ाइल, टेक्स्ट या वैल्यू जोड़ें और सेटिंग बदलें।
- 3
नतीजा कॉपी या डाउनलोड करें। कुछ भी अपलोड या स्टोर नहीं होता।
इस टूल के बारे में
README हर रिपॉज़िटरी का मुखपृष्ठ है: विज़िटर, रिक्रूटर और योगदानकर्ता सबसे पहले इसे ही पढ़ते हैं। यह GitHub README जनरेटर एक छोटे फ़ॉर्म से पूरा, अच्छी तरह व्यवस्थित README.md बनाता है।
प्रोजेक्ट की जानकारी भरें, सेक्शन चालू या बंद करें, अपना टेक स्टैक चुनें, और Markdown कॉपी करें या फ़ाइल डाउनलोड करें। काम करते समय आपका ड्राफ़्ट ब्राउज़र में सेव रहता है।
README कैसे बनाएँ
- प्रोजेक्ट का नाम, टैगलाइन और विवरण लिखें।
- बैज बनाने के लिए अपना GitHub रिपो (user/repo) जोड़ें, और अगर हो तो लाइव डेमो URL भी।
- शामिल करने वाले सेक्शन और अपने स्टैक की टेक्नोलॉजी चुनें।
- लाइसेंस चुनें: MIT, Apache 2.0, GPL 3.0, BSD 3-Clause, MPL 2.0 या Unlicense, और लेखक जोड़ें।
- प्रीव्यू देखें, फिर Markdown कॉपी करें या README.md डाउनलोड करें।
शामिल किए जा सकने वाले सेक्शन
- shields.io के बैज: स्टार, लाइसेंस और अन्य।
- परिचय और फ़ीचर: प्रोजेक्ट क्या करता है और क्यों।
- टेक स्टैक: इस्तेमाल हुई भाषाएँ और फ़्रेमवर्क।
- कोड ब्लॉक के साथ इंस्टॉलेशन और इस्तेमाल।
- चलाने के लिए ज़रूरी एनवायरनमेंट वेरिएबल।
- रोडमैप, योगदान के नियम, लाइसेंस और लेखक।
अच्छा README कैसा होता है
- सबसे ऊपर एक वाक्य में बताएँ कि यह क्या करता है।
- दिखाएँ: ऊपर एक स्क्रीनशॉट या GIF कई पैराग्राफ़ से ज़्यादा समझाता है।
- सेटअप कॉपी पेस्ट लायक बनाएँ: सटीक कमांड, सही क्रम में, जो नई मशीन पर चलें।
- कमांड या विकल्प बदलें तो इसे अपडेट रखें।
नतीजे को मार्कडाउन एडिटर में और बदलें, मार्कडाउन टेबल जनरेटर से टेबल जोड़ें, और मार्कडाउन चीट शीट में सिंटैक्स देखें।
अक्सर पूछे जाने वाले सवाल
README में क्या होना चाहिए?
प्रोजेक्ट क्या करता है, उसे कैसे इंस्टॉल और इस्तेमाल करें, टेक स्टैक, योगदान कैसे दें और लाइसेंस। बैज और स्क्रीनशॉट विज़िटर को जल्दी समझने में मदद करते हैं।
README फ़ाइल कहाँ रखें?
अपनी रिपॉज़िटरी के रूट में, README.md नाम से। GitHub इसे रिपॉज़िटरी पेज पर अपने आप दिखाता है।
क्या बैज जोड़ सकते हैं?
हाँ। अपना GitHub रिपो user/repo के रूप में डालें और जनरेटर उसके लिए shields.io बैज जोड़ देता है।
कौन से लाइसेंस चुन सकते हैं?
MIT, Apache 2.0, GPL 3.0, BSD 3-Clause, MPL 2.0 और Unlicense। अपनी रिपो में पूरी LICENSE फ़ाइल भी जोड़ें।
क्या मेरा ड्राफ़्ट सेव होता है?
हाँ, आपके ब्राउज़र के लोकल स्टोरेज में, इसलिए उसी डिवाइस पर लौटने पर वह मौजूद रहता है।
क्या प्रोफ़ाइल README बना सकते हैं?
हाँ। ठीक अपने यूज़रनेम के नाम से एक रिपॉज़िटरी बनाएँ और README में अपना परिचय दें; GitHub उसे आपकी प्रोफ़ाइल पर दिखाता है।