README जनरेटर
अपने प्रोजेक्ट की ज़रूरी जानकारी भरें: टूल एक संरचित README.md फ़ाइल बनाता है (शीर्षक, विवरण, इंस्टॉलेशन, उपयोग, लाइसेंस), जो कॉपी या डाउनलोड करने के लिए तैयार होती है।
यह कैसे काम करता है
प्रोजेक्ट का नाम (एकमात्र अनिवार्य फ़ील्ड), विवरण, इंस्टॉलेशन कमांड, उपयोग का एक उदाहरण और लाइसेंस भरें। यह टूल इस जानकारी को एक संरचित Markdown दस्तावेज़ में जोड़ता है, जिसमें शीर्षक, विषय-सूची, कोड ब्लॉक वाले “Installation” और “Utilisation” खंड, और एक “Licence” खंड होता है। नतीजा ज़्यादातर GitHub योगदान-मार्गदर्शिकाओं में सुझाई गई संरचना के करीब है।
क्या मैं जनरेट होने के बाद README बदल सकता/सकती हूँ?
जी हाँ, बनाया गया टेक्स्ट किसी भी Markdown की तरह संपादन योग्य शुरुआती बिंदु है: फ़ाइल कॉपी या डाउनलोड करने के बाद अपने सामान्य एडिटर में सीधे खंड (योगदान, टेस्ट, स्क्रीनशॉट) जोड़ें।
क्या लाइसेंस बैज किसी भी लाइसेंस के लिए काम करता है?
बैज shields.io सेवा के ज़रिए, दर्ज किए गए लाइसेंस नाम को जस का तस इस्तेमाल करके बनाया जाता है; यह आम लाइसेंस (MIT, Apache-2.0, GPL-3.0…) के लिए सही दिखता है। किसी कस्टम लाइसेंस के लिए बैज काम तो करता है, पर दिखने में उतना मानकीकृत नहीं होता।
दर्ज की गई सारी जानकारी आपके ब्राउज़र में ही रहती है: यह README बनाने के लिए कुछ भी सर्वर को नहीं भेजा जाता।