Android पर GitHub README कैसे पढ़ें

README वह Markdown फ़ाइल है जो GitHub पर किसी प्रोजेक्ट का परिचय देती है, आमतौर पर इसका नाम README.md होता है। Android फ़ोन पर इसे पढ़ने के लिए अक्सर तुम्हें कुछ नया नहीं चाहिए: तुम्हारा ब्राउज़र इसे फ़ॉर्मैट किए हुए पन्ने की तरह दिखाता है। अगर तुम फ़ाइल खुद चाहते हो, ऑफ़लाइन पढ़ने या रखने के लिए, तो तुम वह एक फ़ाइल या पूरी रिपॉज़िटरी डाउनलोड कर सकते हो, फिर उसे Markdown रीडर में खोल सकते हो। यह गाइड तीनों को कवर करता है।

इस फ़ॉर्मैट में नए हैं? शुरुआत करो .md फ़ाइल क्या है से।

क्या ब्राउज़र काफ़ी है?

अक्सर, हां। रिपॉज़िटरी का पेज अपने फ़ोन के ब्राउज़र में खोलो। GitHub रिपॉज़िटरी के मुख्य फ़ोल्डर, उसके docs फ़ोल्डर या उसके छिपे .github फ़ोल्डर में रखी README ढूंढ लेता है, और उसे उसी पेज पर दिखाता है। तुम्हें कुछ इंस्टॉल करने की ज़रूरत नहीं है, और सार्वजनिक रिपॉज़िटरी साइन इन किए बिना खुलती है।

संकरी स्क्रीन पर, README प्रोजेक्ट के ब्योरे और फ़ाइल सूची के बाद आती है, इसलिए उस तक पहुंचने तक नीचे स्क्रॉल करो। जिस पेज को हमने फ़ोन की चौड़ाई पर जांचा, उस पर चौड़ी सामग्री स्क्रीन के दाहिने किनारे से बाहर चली गई।

एक सीमा जाननी चाहिए। GitHub README को 500 KiB के बाद काट देता है, इसलिए बहुत लंबी README अंत तक न दिखे। और पेज को हर बार खोलने पर कनेक्शन चाहिए।

क्या मैं इसके बदले GitHub ऐप इस्तेमाल कर सकता हूं?

तुम आज़मा सकते हो। GitHub Mobile Android के लिए उपलब्ध है, और GitHub के दस्तावेज़ कहते हैं कि तुम इसे रिपॉज़िटरी ब्राउज़ करने के लिए इस्तेमाल कर सकते हो। वह दस्तावेज़ीकरण यह नहीं बताता कि ऐप में README कैसी दिखती हैं, इसलिए सरल जांच यह है कि अपनी पसंद की कोई रिपॉज़िटरी खोलो और देखो कि वह तुम्हें जंचती है या नहीं। अगर तुम पहले से ऐप इस्तेमाल करते हो, तो शायद तुम्हारे लिए इतना ही काफ़ी हो।

मैं केवल README फ़ाइल कैसे पाऊं?

README रखने का सबसे तेज़ तरीका एक फ़ाइल डाउनलोड करना है। GitHub के दस्तावेज़ ये चरण देते हैं:

  1. रिपॉज़िटरी खोलो और फ़ाइल सूची में README.md पर टैप करो।
  2. फ़ाइल व्यू के ऊपर दाईं ओर, सादा टेक्स्ट देखने के लिए Raw पर टैप करो, या उसे सेव करने के लिए Download raw file आइकन पर।

इन बटन तक पहुंचना फ़ोन पर मुश्किल हो सकता है। हमने पुष्टि की कि वे पेज पर हैं, लेकिन फ़ोन की चौड़ाई पर पेज का वह हिस्सा स्क्रीन से बाहर जा सकता है, इसलिए तुम्हें बगल में स्क्रॉल करना पड़ सकता है।

अगर तुम उन्हें नहीं ढूंढ पाते, तो फ़ाइल का रॉ पता खुद टाइप करो। मालिक, रिपॉज़िटरी और ब्रांच के नाम बदलकर डालो:

https://raw.githubusercontent.com/OWNER/REPO/main/README.md

यह पता फ़ाइल को सादे टेक्स्ट के रूप में लौटाता है। जिस रिपॉज़िटरी की मुख्य ब्रांच का नाम अलग है, उसमें main की जगह वह नाम चाहिए।

मुझे पूरी रिपॉज़िटरी कब डाउनलोड करनी चाहिए?

पूरी रिपॉज़िटरी तब डाउनलोड करो जब README दूसरी फ़ाइलों पर निर्भर हो। README अक्सर तस्वीरों और दूसरे दस्तावेज़ों की ओर रिलेटिव लिंक से इशारा करती है, यानी रिपॉज़िटरी के भीतर के पाथ। अकेली डाउनलोड की गई फ़ाइल उनके बिना आती है।

GitHub के दस्तावेज़ ये चरण देते हैं:

  1. रिपॉज़िटरी का मुख्य पेज खोलो।
  2. फ़ाइलों की सूची के ऊपर, Code पर टैप करो।
  3. Download ZIP पर टैप करो।

ZIP फ़ाइलों का एक स्नैपशॉट है, प्रोजेक्ट के इतिहास के बिना, जो पढ़ने के लिए तुम्हें चाहिए बस इतना ही है। फिर तुम्हें उसे अनपैक करना होगा। तुम्हारे फ़ोन का फ़ाइल मैनेजर शायद यह कर सके। अगर वह नहीं कर सकता, तो तुम्हें ऐसा ऐप चाहिए जो कर सके।

डाउनलोड करने के बाद मैं .md फ़ाइल कैसे पढ़ूं?

सादे टेक्स्ट के रूप में खोलने पर, फ़ाइल अपने Markdown चिह्न दिखाती है: शीर्षकों के लिए #, बोल्ड के लिए ** और तालिकाओं के लिए |। Markdown रीडर उन्हें पन्ने में बदल देता है। ज़्यादातर रीडर फ़ाइल को दो तरीकों में से एक से खोल सकते हैं:

ऐसा रीडर ढूंढो जो तालिकाएं और कोड ब्लॉक बनाता हो, क्योंकि README इनका अक्सर उपयोग करती हैं। यह भी जांचो कि वह तस्वीरों और लिंक के साथ कैसा बर्ताव करता है, क्योंकि अकेली डाउनलोड की गई फ़ाइल के साथ वही चीज़ें खोती हैं।

PilcrowMD README को कैसे संभालता है?

PilcrowMD हमारा मुफ़्त Android Markdown रीडर है। यह तालिकाओं, टास्क सूचियों और कॉलआउट समेत GitHub-फ़्लेवर्ड Markdown पढ़ता है, और इसे खाते की ज़रूरत नहीं है। इसकी वेलकम स्क्रीन पर फ़ाइल खोलें पर टैप करो, या अपने फ़ाइल मैनेजर में Open with के तहत इसे चुनो।

कुछ चीज़ें GitHub पेज से अलग काम करती हैं:

और जानने के लिए देखो एक पेज में Markdown सिंटैक्स और Markdown को निजी तौर पर और ऑफ़लाइन कैसे पढ़ें।

Mac पर भी: Mac के लिए PilcrowMD (बीटा)