Чи досить браузера?
Часто так. Відкрий сторінку репозиторію в браузері телефона. GitHub знаходить README, що лежить в основній теці репозиторію, у його теці docs або в прихованій теці .github, і показує його на цій сторінці. Нічого встановлювати не потрібно, а публічний репозиторій відкривається без входу.
На вузькому екрані README йде після відомостей про проєкт і списку файлів, тож прокручуй вниз, доки не дійдеш до нього. На сторінці, яку ми перевіряли за ширини телефона, широкий вміст виходив за правий край екрана.
Є одне обмеження, про яке варто знати. GitHub обрізає README після 500 КіБ, тож дуже довгий може не показатися до кінця. А сторінці щоразу потрібне з’єднання, коли ти її відкриваєш.
Чи можна натомість скористатися застосунком GitHub?
Можна спробувати. GitHub Mobile доступний для Android, і в документації GitHub сказано, що ним можна переглядати репозиторії. У цій документації не описано, як виглядають README в застосунку, тож найпростіший тест: відкрий важливий для тебе репозиторій і подивись, чи тебе це влаштовує. Якщо ти вже користуєшся застосунком, цього може вистачити.
Як отримати лише файл README?
Завантажити один файл найшвидше, щоб зберегти README. У документації GitHub наведено такі кроки:
- Відкрий репозиторій і торкнися
README.mdу списку файлів. - У правому верхньому куті перегляду файлу торкнися Raw, щоб побачити звичайний текст, або піктограми Download raw file, щоб його зберегти.
До цих кнопок на телефоні буває важко дістатися. Ми підтвердили, що вони є на сторінці, але за ширини телефона ця частина сторінки може виходити за екран, тож, можливо, доведеться прокрутити вбік.
Якщо ти не можеш їх знайти, введи необроблену адресу файлу самостійно. Підстав імена власника, репозиторію та гілки:
https://raw.githubusercontent.com/OWNER/REPO/main/README.md
Ця адреса повертає файл як звичайний текст. Якщо основна гілка репозиторію має іншу назву, підстав цю назву замість main.
Коли варто завантажувати весь репозиторій?
Завантажуй весь репозиторій, коли README залежить від інших файлів. README часто посилається на зображення та інші документи відносними посиланнями, тобто шляхами всередині репозиторію. Один завантажений файл приходить без них.
У документації GitHub наведено такі кроки:
- Відкрий основну сторінку репозиторію.
- Над списком файлів торкнися Code.
- Торкнися Download ZIP.
ZIP це знімок файлів без історії проєкту, чого цілком досить для читання. Потім його потрібно розпакувати. Файловий менеджер твого телефона, можливо, це вміє. Якщо ні, знадобиться застосунок, який це може.
Як прочитати файл .md після завантаження?
Відкритий як звичайний текст, файл показує свої символи Markdown: # для заголовків, ** для жирного шрифту і | для таблиць. Засіб читання Markdown перетворює їх на сторінку. Більшість засобів читання можуть відкрити файл одним із двох способів:
- Зсередини застосунку, власною кнопкою відкриття та засобом вибору файлів Android.
- З файлового менеджера, торкнувшись файлу й вибравши Відкрити за допомогою.
Шукай засіб читання, який малює таблиці й блоки коду, бо README часто їх використовують. Перевір також, як він ставиться до зображень і посилань, бо саме їх ти втрачаєш з одним завантаженим файлом.
Як PilcrowMD працює з README?
PilcrowMD це наш безкоштовний засіб читання Markdown для Android. Він читає Markdown у стилі GitHub, зокрема таблиці, списки завдань і виділені блоки, і не потребує облікового запису. Торкнися Відкрити файл на його початковому екрані або вибери його в пункті Відкрити за допомогою у твоєму файловому менеджері.
Кілька речей працюють інакше, ніж на сторінці GitHub:
- Зображення, що лежать поруч із файлом, показуються всередині нього. Веб-зображення ніколи не завантажуються, тож README, який завантажує зображення з вебу, показується без них.
- Посилання між файлами працюють лише для нотаток у теці, яку ти додаєш. Для розпакованого репозиторію додай теку в розділ Мої теки.
- Посилання на заголовки в тому самому файлі переходять до цього заголовка.
Більше див. у Синтаксис Markdown на одній сторінці і як читати Markdown приватно й офлайн.
Також для Mac: PilcrowMD для Mac (бета)