README बनाना

GitHub Concepts परिचय

Jasmin Ludolf

Content Developer, DataCamp

README संपादित करें

README संपादित करें

README संपादित करें

Markdown

Edit बनाम Preview

Headings

Headings

Headings

टेक्स्ट फ़ॉर्मैटिंग

हाइपरलिंक्स

हाइपरलिंक्स

Images

README लिखना

• विवरणात्मक होना चाहिए
  • कोई भी हमारे प्रोजेक्ट को समझ सके
• रिपोजिटरी की सामग्री सूचीबद्ध करें
• प्रोजेक्ट दूसरों को साफ़-साफ़ समझाए

README की मूल बातें

• शीर्षक
• टेक्नोलॉजी का विवरण
  • क्यों?
• प्रोसेस का विवरण
  • क्यों?
• सामग्री-सूची

README एक्स्ट्रा

• प्रोजेक्ट कैसे शुरू हुआ
• मोटिवेशन
• सीमाएँ
• चुनौतियाँ
• कौन सी समस्या हल करनी है
• प्रयोजन क्या है
• क्रेडिट्स

अभ्यास करते हैं!

GitHub Concepts परिचय