Innehållsförteckning:

Bättre sätt att visa/dokumentera filer på instruktioner: 4 steg
Bättre sätt att visa/dokumentera filer på instruktioner: 4 steg

Video: Bättre sätt att visa/dokumentera filer på instruktioner: 4 steg

Video: Bättre sätt att visa/dokumentera filer på instruktioner: 4 steg
Video: Slutför React Query-kurs på en timme | TanStack Query v4 för nybörjare 2024, December
Anonim
Bättre sätt att visa/dokumentera filer på instruktioner
Bättre sätt att visa/dokumentera filer på instruktioner
Bättre sätt att visa/dokumentera filer på instruktioner
Bättre sätt att visa/dokumentera filer på instruktioner

Människor inkluderar ofta filer där för projekt via uppladdningsbara instruktioner.

Ofta är detta programvarukällfiler som till och med kan vara det lärande hjärtslagets hjärta. Men Instructables ger inte läsaren ett enkelt sätt att läsa och granska koden. (vanligtvis skulle du behöva ladda ner koden, eventuellt packa upp och sedan hitta rätt visningsprogram.) Ofta visar sig koden som jag har hittat inte vara värd ansträngningen. Vad sägs om ett enda klick (+- 2) för att se programmen? Detta är hur.

(Ovanstående bild från:

Verktyg och tillbehör:

  • Dator
  • GitHub offentligt gratis konto

Steg 1: Visa gammal stil

Ser på gammal stil
Ser på gammal stil

För ett tag sedan skrev jag en instruerbar på en smart terminal för användning med Arduinos och andra mikrokontroller. Du kan se det här: Python -terminal för billig Pi Arduino -anslutning

Filavsnittet ser mest ut som bilden ovan, om du klickar på filerna får du en nedladdning med ett filnamn som är förlorat och behöver göra lite datordans för att öppna den och läsa den. Då måste du hålla reda på filen på din dator.

Steg 2: Visa ny stil

Tittar på ny stil
Tittar på ny stil

Här ser dina kodfiler ut som kod.-p.webp

Hur man gör det:

Lägg bara till en länk till din github -repo. och en gång gjord av instruktörer ser det ut så här:

Projektets GitHub -filer

I nästa steg har vi några detaljerade bilder på hur du lägger till länken från instruktörsredigeraren.

Steg 3: Infoga länken (detaljer)

Sätt in länken (detaljer)
Sätt in länken (detaljer)
Sätt in länken (detaljer)
Sätt in länken (detaljer)
Sätt in länken (detaljer)
Sätt in länken (detaljer)
Sätt in länken (detaljer)
Sätt in länken (detaljer)
  • Bild 1: Klicka på länkikonen (höglighet).
  • Bild 2: Du får länkdialogrutan.
  • Bild 3: Fyll i dialogrutan.
  • Bild 4: Och du får en trevlig länk i din instruerbara.

Om alla skulle göra detta skulle det vara så mycket lättare att se kod (och andra filtyper, och till och med ladda ner hela uppsättningen filer som en trevlig zip -fil med interna namn och katalogstruktur bevarad.

Jag gillar det här så mycket att jag kommer att gå tillbaka och fixa alla mina gamla instruktioner!

Steg 4: Relaterade länkar

  • 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 för billig Pi Arduino -anslutning

Rekommenderad: