Betere manier om bestanden op Instructables te bekijken / documenteren: 4 stappen:

2024 Auteur: John Day | [email protected]. Laatst gewijzigd: 2024-01-30 11:16

Mensen nemen vaak hun bestanden op voor projecten via uploads van Instructables.

Vaak zijn dit softwarebronbestanden die zelfs het kloppende hart van de instructable kunnen zijn. Maar Instructables geeft de lezer geen gemakkelijke manier om de code te lezen en te beoordelen. (meestal zou je de code moeten downloaden, eventueel uitpakken, en dan het juiste kijkprogramma zoeken.) Vaak blijkt de code die ik dan heb gevonden niet de moeite waard te zijn. Wat dacht je van een methode met één klik (+- 2) om de programma's te bekijken? Dit is hoe.

(Bovenstaande afbeelding van:

Gereedschap en benodigdheden:

• Computer
• GitHub openbaar gratis account

Stap 1: Oude stijl bekijken

Een tijdje geleden schreef ik een instructable op een Smart Terminal voor gebruik met Arduino's en andere microcontrollers. Je kunt het hier zien: Python Terminal voor goedkope Pi Arduino-verbinding

Het bestandsgedeelte ziet er grotendeels uit als de bovenstaande afbeelding, als u op de bestanden klikt, krijgt u een download met een verminkte bestandsnaam en moet u een kleine computerdans doen om het te openen en te lezen. Dan moet u het bestand op uw computer bijhouden.

Stap 2: Nieuwe stijl bekijken

Hier zien uw codebestanden eruit als code. PNG-bestanden zien eruit als afbeeldingen, PDF-bestanden zien eruit als documenten. Ik denk dat andere typen correct worden weergegeven, maar ik heb geen referentie gevonden.

Hoe je dat doet:

Voeg gewoon een link toe aan uw github-repo. en eenmaal weergegeven door instructables ziet het eruit als:

GitHub-bestanden van het project

In de volgende stap hebben we enkele gedetailleerde foto's van het toevoegen van de link vanuit de instructables-editor.

Stap 3: Voeg de link in (details)

• Afbeelding 1: Klik op het koppelingspictogram (gemarkeerd).
• Afbeelding 2: U krijgt het koppelingsdialoogvenster.
• Afbeelding 3: Vul het dialoogvenster in.
• Afbeelding 4: En je krijgt een mooie link in je instructable.

Als iedereen dit zou doen, zou het zoveel gemakkelijker zijn om code te bekijken (en andere bestandstypen, en zelfs de hele set bestanden te downloaden als een mooi zip-bestand met behoud van interne namen en directorystructuur.

Ik vind dit zo leuk dat ik terug ga om al mijn oude instructables te repareren!

Stap 4: Gerelateerde 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 voor goedkope Pi Arduino-verbinding