Bedre måte å vise/dokumentere filer på instruksjoner: 4 trinn

2024 Forfatter: John Day | [email protected]. Sist endret: 2024-01-30 11:22

Folk inkluderer ofte det der filer for prosjektet via Instructables opplastinger.

Ofte er dette programvarekildefiler som til og med kan være det bankende hjertet til den instruerbare. Men Instructables gir ikke leseren en enkel måte å lese og gjennomgå koden. (vanligvis må du laste ned koden, eventuelt pakke ut, og deretter finne det riktige visningsprogrammet.) Ofte viser det seg at koden jeg har funnet ut ikke er verdt innsatsen. Hva med en ett-klikk (+- 2) metode for å se programmene? Dette er hvordan.

(Over bildet fra:

Verktøy og rekvisita:

• Datamaskin
• GitHub offentlig gratis konto

Trinn 1: Visning av gammel stil

For en stund siden skrev jeg en instruks på en smart terminal for bruk med Arduinos og andre mikrokontrollere. Du kan se det her: Python -terminal for billig Pi Arduino -tilkobling

Filseksjonen ser stort sett ut som bildet ovenfor, hvis du klikker på filene, får du en nedlasting med et filfilnavn og trenger å danse litt på datamaskinen for å åpne den og lese den. Da må du holde oversikt over filen på datamaskinen din.

Trinn 2: Se på ny stil

Her ser kodefilene dine ut som kode.-p.webp

Hvordan gjøre det:

Bare legg til en lenke til github -repoen din. og en gang gjengitt av instruktører ser det ut som:

Prosjektets GitHub -filer

I neste trinn har vi noen detaljerte bilder av å legge til lenken fra instruktørredigereren.

Trinn 3: Sett inn lenken (detaljer)

• Bilde 1: Klikk på lenkeikonet (høylighet).
• Bilde 2: Du får koblingsdialogboksen.
• Bilde 3: Fyll ut dialogboksen.
• Bilde 4: Og du får en fin lenke i din instruerbare.

Hvis alle ville gjøre dette ville det være så mye lettere å se kode (og andre filtyper, og til og med laste ned hele settet med filer som en fin zip -fil med interne navn og katalogstruktur bevart.

Jeg liker dette så godt at jeg kommer til å gå tilbake og fikse alle mine gamle instrukser!

Trinn 4: Relaterte koblinger

• 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 -terminal for billig Pi Arduino -tilkobling