Satura rādītājs:

Labāks veids, kā skatīt/dokumentēt instrukciju failus: 4 soļi
Labāks veids, kā skatīt/dokumentēt instrukciju failus: 4 soļi

Video: Labāks veids, kā skatīt/dokumentēt instrukciju failus: 4 soļi

Video: Labāks veids, kā skatīt/dokumentēt instrukciju failus: 4 soļi
Video: CS50 2015 – первая неделя 2024, Novembris
Anonim

Cilvēki bieži iekļauj projekta failus, izmantojot Instructables augšupielādes.

Bieži vien tie ir programmatūras avota faili, kas var būt pat pamācāmā sirds. Bet Instructables nesniedz lasītājam vienkāršu veidu, kā nolasīt un pārskatīt kodu. (parasti jums būs jālejupielādē kods, iespējams, jāizsaiņo un pēc tam jāatrod pareizā skatīšanās programma.) Bieži vien pēc tam atklātais kods nav tā vērts. Kā būtu ar viena klikšķa (+- 2) metodi programmu skatīšanai? Šādi.

(Augšējais attēls no:

Instrumenti un piederumi:

  • Dators
  • GitHub publiskais bezmaksas konts

1. darbība: vecā stila apskate

Vecā stila apskate
Vecā stila apskate

Pirms neilga laika es uzrakstīju instrukciju viedajam terminālim, lai to varētu izmantot kopā ar Arduinos un citiem mikrokontrolleriem. To var redzēt šeit: Python terminālis lētam Pi Arduino savienojumam

Failu sadaļa lielākoties izskatās kā augstāk redzamajā attēlā, ja noklikšķināt uz failiem, jūs saņemat lejupielādi ar sagrozītu faila nosaukumu un jums ir jāveic neliela deja ar datoru, lai to atvērtu un izlasītu. Tad jums ir jāseko datoram esošajam failam.

2. darbība: jauna stila apskate

Jauna stila apskate
Jauna stila apskate

Šeit jūsu koda faili izskatās kā kods.-p.webp

Kā to izdarīt:

Vienkārši pievienojiet saiti savam github repo. un pēc norādījumu sniegšanas tas izskatās šādi:

Projekta GitHub faili

Nākamajā solī mums ir daži detalizēti attēli par saites pievienošanu no instrukciju redaktora.

3. darbība: ievietojiet saiti (detaļas)

Ievietojiet saiti (detaļas)
Ievietojiet saiti (detaļas)
Ievietojiet saiti (detaļas)
Ievietojiet saiti (detaļas)
Ievietojiet saiti (detaļas)
Ievietojiet saiti (detaļas)
Ievietojiet saiti (detaļas)
Ievietojiet saiti (detaļas)
  • 1. attēls: noklikšķiniet uz saites ikonas (augsta līmeņa).
  • 2. attēls: tiek parādīts saites dialoglodziņš.
  • 3. attēls: aizpildiet dialoglodziņu.
  • 4. attēls. Un jūs saņemat jauku saiti savā pamācībā.

Ja visi to darītu, būtu daudz vieglāk apskatīt kodu (un citus failu tipus) un pat lejupielādēt visu failu kopu kā jauku zip failu ar saglabātu iekšējo nosaukumu un direktoriju struktūru.

Man tas tik ļoti patīk, ka es atgriezīšos un labošu visas vecās instrukcijas!

4. darbība. Saistītās saites

  • 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 terminālis lētam Pi Arduino savienojumam

Ieteicams: