README.md जनरेटर
एक छोटा फ़ॉर्म भरें और बैज, इंस्टॉलेशन, उपयोग, विशेषताएँ, योगदान और लाइसेंस सेक्शन वाली साफ़ GitHub README.md पाएँ, साथ में लाइव Markdown पूर्वावलोकन।
owner/repo, बैज और git clone कमांड के लिए।
हर पंक्ति में एक विशेषता।
सेक्शन शीर्षक अंग्रेज़ी में लिखे जाते हैं, जो ओपन-सोर्स README की आम परंपरा है। आपका अपना टेक्स्ट वैसा ही रहता है।
संबंधित टूल्स
सभी देखेंREADME जनरेटर क्या है?
README रिपॉज़िटरी में लोगों की पढ़ी पहली फ़ाइल होती है। यह टूल कुछ फ़ील्ड – प्रोजेक्ट का नाम, विवरण, विशेषताएँ, इंस्टॉल और उपयोग के कमांड, लाइसेंस और लेखक – को वैकल्पिक shields.io बैज, विषय-सूची और योगदान गाइड के साथ सुव्यवस्थित README.md में बदलता है। आप Markdown स्रोत और रेंडर किए पूर्वावलोकन के बीच बदल सकते हैं।
README जनरेटर का उपयोग कैसे करें
- प्रोजेक्ट का नाम दर्ज करें और, अगर वह GitHub पर है, तो GitHub रिपॉज़िटरी
owner/repoके रूप में। - एक पंक्ति की टैगलाइन, विवरण, विशेषताएँ (हर पंक्ति में एक), इंस्टॉलेशन कमांड और उपयोग का उदाहरण जोड़ें।
- लाइसेंस चुनें, लेखक जोड़ें, और बैज, विषय-सूची तथा योगदान सेक्शन चालू/बंद करें।
- पूर्वावलोकन जाँचें, फिर README.md कॉपी या डाउनलोड करें।
उदाहरण
Project name tiny-cache, tagline "A 1 KB LRU cache", repository acme/tiny-cache, install npm install, license MIT, no badges/TOC/contributing
# tiny-cache > A 1 KB LRU cache ## Installation ```bash git clone https://github.com/acme/tiny-cache.git cd tiny-cache npm install ``` ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
README जनरेटर का उपयोग कब करें
नई लाइब्रेरी, CLI, साइड प्रोजेक्ट या आंतरिक रिपॉज़िटरी के लिए एक मिनट में README शुरू करने और फिर टेक्स्ट हाथ से सुधारने के लिए इसका उपयोग करें। यह उचित ढाँचा बनाता है, दस्तावेज़ीकरण नहीं: कॉन्फ़िगरेशन, API का ब्योरा और आपके प्रोजेक्ट के उदाहरण आपको अब भी खुद समझाने होंगे।
README जनरेटर कैसे काम करता है
फ़ॉर्म को GitHub-flavored Markdown में जोड़ा जाता है: नाम वाला H1, वैकल्पिक बैज (img.shields.io से लाइसेंस, स्टार, इश्यू, रिपॉज़िटरी से लिंक किए हुए), ब्लॉककोट टैगलाइन, फिर Features, Installation (रिपॉज़िटरी सेट होने पर git clone + cd ब्लॉक के साथ), Usage (आपकी चुनी भाषा में फ़ेंस्ड कोड ब्लॉक), Contributing, License और Author के सेक्शन। विषय-सूची के लिंक GitHub के हेडिंग एंकर नियम इस्तेमाल करते हैं। पूर्वावलोकन marked से रेंडर होता है और DOMPurify से सैनिटाइज़ किया जाता है।
सामान्य उपयोग मामले
- नए ओपन-सोर्स पैकेज की README शुरू करना
- टीम की रिपॉज़िटरी में README की संरचना एक-सी करना
- लाइसेंस और योगदान सेक्शन जल्दी जोड़ना
- पोर्टफ़ोलियो या हैकाथॉन प्रोजेक्ट की README बनाना
अक्सर पूछे जाने वाले प्रश्न
क्या यह LICENSE फ़ाइल भी बनाता है?
नहीं। यह LICENSE से लिंक करने वाला लाइसेंस सेक्शन जोड़ता है; लाइसेंस का टेक्स्ट खुद अपनी रिपॉज़िटरी में जोड़ें (GitHub आपके लिए बना सकता है)।
शीर्षक अंग्रेज़ी में क्यों हैं?
ओपन-सोर्स README में अंग्रेज़ी सेक्शन शीर्षक परंपरा है और इससे दुनिया भर के योगदानकर्ताओं के लिए प्रोजेक्ट स्कैन करना आसान होता है। आपका अपना टेक्स्ट उसी भाषा में रहता है जिसमें आप लिखते हैं।
क्या बैज निजी रिपॉज़िटरी के लिए काम करते हैं?
Shields.io निजी GitHub रिपॉज़िटरी नहीं पढ़ सकता, इसलिए स्टार और इश्यू बैज केवल सार्वजनिक रिपॉज़िटरी का डेटा दिखाते हैं।