Καλύτερος τρόπος προβολής/τεκμηρίωσης αρχείων σε οδηγίες χρήσης: 4 βήματα

2024 Συγγραφέας: John Day | [email protected]. Τελευταία τροποποίηση: 2024-01-30 08:34

Οι άνθρωποι συχνά περιλαμβάνουν εκεί αρχεία για το έργο μέσω μεταφορτώσεων Instructables.

Συχνά πρόκειται για αρχεία προέλευσης λογισμικού που μπορεί ακόμη και να είναι η καρδιά που χτυπάει το εκπαιδευτικό. Αλλά το Instructables δεν δίνει στον αναγνώστη έναν εύκολο τρόπο ανάγνωσης και αναθεώρησης του κώδικα. (συνήθως θα χρειαστεί να κατεβάσετε τον κώδικα, ενδεχομένως να αποσυμπιέσετε, και στη συνέχεια να βρείτε το σωστό πρόγραμμα προβολής.) Συχνά ο κώδικας που βρήκα τότε αποδεικνύεται ότι δεν αξίζει τον κόπο. Τι θα λέγατε για μια μέθοδο ενός κλικ (+- 2) για την προβολή των προγραμμάτων; Ετσι.

(Πάνω εικόνα από:

Εργαλεία και αναλώσιμα:

• Υπολογιστή
• Δημόσιος δωρεάν λογαριασμός GitHub

Βήμα 1: Προβολή παλιού στυλ

Πριν από λίγο καιρό έγραψα ένα εκπαιδευτικό σε ένα έξυπνο τερματικό για χρήση με Arduinos και άλλους μικροελεγκτές. Μπορείτε να το δείτε εδώ: Python Terminal for Cheap Pi Arduino Connection

Η ενότητα αρχείων μοιάζει ως επί το πλείστον με την παραπάνω εικόνα, αν κάνετε κλικ στα αρχεία λαμβάνετε μια λήψη με ένα όνομα αρχείου που έχει παραμορφωθεί και πρέπει να κάνετε λίγο χορό στον υπολογιστή για να το ανοίξετε και να το διαβάσετε. Στη συνέχεια, πρέπει να παρακολουθείτε το αρχείο στον υπολογιστή σας.

Βήμα 2: Προβολή νέου στυλ

Εδώ τα αρχεία κώδικα μοιάζουν με κώδικα. Τα αρχεία-p.webp

Πως να το κάνεις:

Απλώς προσθέστε έναν σύνδεσμο στο repo του 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 για φτηνή σύνδεση Arduino Pi