Лучший способ просмотра / документирования файлов на Instructables: 4 шага

2024 Автор: John Day | [email protected]. Последнее изменение: 2024-01-30 11:51

Люди часто включают туда файлы для проекта через загрузку Instructables.

Часто это исходные файлы программного обеспечения, которые могут быть даже сердцем инструктируемого. Но Instructables не дает читателю простого способа прочитать и просмотреть код. (обычно вам нужно загрузить код, возможно, разархивировать, а затем найти подходящую программу для просмотра.) Часто код, который я нашел, не стоит затраченных усилий. Как насчет метода просмотра программ в один клик (+ - 2)? Вот как.

(Изображение вверху:

Инструменты и расходные материалы:

• Компьютер
• Публичная бесплатная учетная запись GitHub

Шаг 1. Просмотр старого стиля

Некоторое время назад я написал инструкцию по смарт-терминалу для использования с Arduinos и другими микроконтроллерами. Вы можете увидеть это здесь: Терминал Python для подключения дешевого Pi Arduino

Раздел файлов в основном выглядит так, как на картинке выше, если вы щелкнете по загружаемым файлам с искаженным именем, и вам нужно немного потанцевать на компьютере, чтобы открыть и прочитать. Затем вам нужно следить за файлом на вашем компьютере.

Шаг 2: просмотр нового стиля

Здесь ваши файлы кода выглядят как код. Файлы-p.webp

Как это сделать:

Просто добавьте ссылку на свое репозиторий на github. и после рендеринга инструкциями это выглядит так:

Файлы проекта на GitHub

На следующем шаге у нас есть несколько подробных изображений добавления ссылки из редактора инструкций.

Шаг 3. Вставьте ссылку (подробности)

• Изображение 1: Щелкните значок ссылки (выделен).
• Изображение 2: Вы видите диалоговое окно ссылки.
• Рисунок 3: Заполните диалоговое окно.
• Изображение 4: И вы получаете красивую ссылку в своем руководстве.

Если бы все сделали это, было бы намного проще просматривать код (и другие типы файлов и даже загружать весь набор файлов в виде хорошего zip-файла с сохраненными внутренними именами и структурой каталогов.

Мне это так нравится, что я собираюсь вернуться и исправить все свои старые инструкции!

Шаг 4. Ссылки по теме

• https://www.instructables.com/id/Include-Code-in-an-Instructable/
• https://www.instructables.com/id/Introduction-to-GitHub/
• https://www.instructables.com/id/Downloading-Code-From-GitHub/
• Терминал Python для дешевого подключения Pi Arduino