Indholdsfortegnelse:

Bedre måde at se/dokumentere filer på instruktioner: 4 trin
Bedre måde at se/dokumentere filer på instruktioner: 4 trin

Video: Bedre måde at se/dokumentere filer på instruktioner: 4 trin

Video: Bedre måde at se/dokumentere filer på instruktioner: 4 trin
Video: Штукатурка стен - самое полное видео! Переделка хрущевки от А до Я. #5 2024, November
Anonim
Bedre måde at se/dokumentere filer på instruktioner
Bedre måde at se/dokumentere filer på instruktioner
Bedre måde at se/dokumentere filer på instruktioner
Bedre måde at se/dokumentere filer på instruktioner

Folk inkluderer ofte der filer til projekt via uploads fra Instructables.

Ofte er dette softwarekildefiler, der endda kan være det vejledende hjerte for den instruerbare. Men Instructables giver ikke læseren en let måde at læse og gennemgå koden. (typisk skal du downloade koden, eventuelt udpakke og derefter finde det rigtige visningsprogram.) Ofte viser den kode, jeg har fundet, sig ikke at være indsatsen værd. Hvad med en et-kliks (+- 2) metode til visning af programmerne? Sådan her.

(Ovenstående billede fra:

Værktøj og tilbehør:

  • Computer
  • GitHub offentlig gratis konto

Trin 1: Visning af gammel stil

Ser gammel stil
Ser gammel stil

For et stykke tid siden skrev jeg en instruerbar på en smart terminal til brug med Arduinos og andre mikrokontrollere. Du kan se det her: Python -terminal til billig Pi Arduino -forbindelse

Filafsnittet ligner stort set ovenstående billede, hvis du klikker på filerne, får du en download med et mangelfuldt filnavn og skal lave en lille computerdans for at åbne det og læse det. Derefter skal du holde styr på filen på din computer.

Trin 2: Visning af ny stil

Visning af ny stil
Visning af ny stil

Her ligner dine kodefiler kode.-p.webp

Hvordan gør man det:

Tilføj bare et link til din github -repo. og når den er gengivet med instruktører, ser den sådan ud:

Projektets GitHub -filer

I det næste trin har vi nogle detaljerede billeder af tilføjelse af linket fra instruktøreditoren.

Trin 3: Indsæt linket (detaljer)

Indsæt linket (detaljer)
Indsæt linket (detaljer)
Indsæt linket (detaljer)
Indsæt linket (detaljer)
Indsæt linket (detaljer)
Indsæt linket (detaljer)
Indsæt linket (detaljer)
Indsæt linket (detaljer)
  • Billede 1: Klik på linkikonet (højlighed).
  • Billede 2: Du får link -dialogboksen.
  • Billede 3: Udfyld dialogboksen.
  • Billede 4: Og du får et godt link i din instruerbare.

Hvis alle ville gøre dette, ville det være meget lettere at se kode (og andre filtyper og endda downloade hele sæt filer som en flot zip -fil med interne navne og biblioteksstruktur bevaret.

Jeg kan godt lide dette så meget, at jeg vil gå tilbage og reparere alle mine gamle instruktioner!

Trin 4: Relaterede links

  • 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 til billig Pi Arduino -forbindelse

Anbefalede: