По -добър начин за преглед/документиране на файлове с инструкции: 4 стъпки

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

Хората често включват файлове за проекти чрез качване на Instructables.

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

(Горе изображение от:

Инструменти и консумативи:

• Компютър
• Публичен безплатен акаунт в GitHub

Стъпка 1: Преглед на стария стил

Преди доста време написах инструкция на Smart Terminal за използване с 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 връзка