Parem viis failide vaatamiseks/dokumenteerimiseks juhistes: 4 sammu

Sisukord:

Samm: vana stiili vaatamine
2. samm: uue stiili vaatamine
Samm: sisestage link (üksikasjad)
4. samm: seotud lingid

Video: Parem viis failide vaatamiseks/dokumenteerimiseks juhistes: 4 sammu

2024 Autor: John Day | [email protected]. Viimati modifitseeritud: 2024-01-30 08:47

Parem viis failide vaatamiseks/dokumenteerimiseks juhistes

Inimesed lisavad sinna sageli projekti faile Instructabeli üleslaadimise kaudu.

Sageli on tegemist tarkvara lähtefailidega, mis võivad olla isegi juhendatava süda. Kuid Instructables ei anna lugejale lihtsat viisi koodi lugemiseks ja ülevaatamiseks. (tavaliselt peate koodi alla laadima, võimaluse korral pakkima, seejärel leidma õige vaatamisprogrammi.) Sageli osutub minu leitud kood siis vaeva väärt. Kuidas oleks ühe klõpsuga (+- 2) meetod programmide vaatamiseks? See on see, kuidas.

(Pildi kohal:

Tööriistad ja tarvikud:

Arvuti
GitHubi avalik tasuta konto

Samm: vana stiili vaatamine

Üsna mõnda aega tagasi kirjutasin nutiterminalile juhendi kasutamiseks Arduinose ja muude mikrokontrolleritega. Seda näete siin: odava Pi Arduino ühenduse jaoks mõeldud Pythoni terminal

Failide jaotis näeb enamasti välja nagu ülaltoodud pildil, kui klõpsate failidel, saate allalaaditud failinime ja peate selle avamiseks ja lugemiseks natuke arvutitantsu tegema. Siis peate oma arvutis faili jälgima.

2. samm: uue stiili vaatamine

Siin näevad teie koodifailid välja nagu kood.-p.webp

Kuidas seda teha:

Lisage lihtsalt link oma githubi reposse. ja kui juhistega renderdatud, näeb see välja selline:

Projekti GitHubi failid

Järgmises etapis on meil mõned üksikasjalikud pildid juhendi redaktori lingi lisamisest.

Samm: sisestage link (üksikasjad)

Pilt 1: klõpsake lingi ikooni (kõrgelt hinnatud).
Pilt 2: saate lingi dialoogiboksi.
Pilt 3: täitke dialoogiboks.
Pilt 4: Ja saate oma juhendis toreda lingi.

Kui kõik seda teeksid, oleks koodi (ja muid failitüüpe) palju lihtsam vaadata ja isegi kogu failide komplekt kena ZIP -failina alla laadida, säilitades sisemised nimed ja kataloogistruktuuri.

See meeldib mulle nii väga, et lähen tagasi ja parandan kõik oma vanad juhendid!

4. samm: seotud lingid

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/
Pythoni terminal odava Pi Arduino ühenduse jaoks

Soovitan:

Kuidas mängida kohmakat robotit juhistes: 5 sammu (piltidega)

Kuidas mängida kohmakat robotit juhistes: Kui teil on piisavalt õnne (või õnnetust), et leida juhitava serveri veateate ees, nautige seda. Mäng, mis on sellesse sisseehitatud, on lihtsalt juhitav robot ja mutrivõtmed nagu flappy lind. Selles ma

Sõrmejäljeanduri kasutamine aja vaatamiseks koos XAMP -lahendusega: 6 sammu (piltidega)

Sõrmejäljeanduri kasutamine aja jooksul koos XAMP -lahendusega: Kooliprojekti jaoks otsisime lahendust õpilaste kohaloleku jälgimiseks. Paljud meie õpilased tulevad hilja. Nende kohaloleku kontrollimine on tüütu töö. Teisest küljest arutatakse palju, sest õpilased ütlevad sageli

Juhiste vaatamiseks algse liidese juurde naasmine: 3 sammu

Juhiste vaatamiseks algse liidese juurde naasmine: kui te ei saanud sellest aru, on Instructabeli kasutajaliides asjade vaatamiseks muudetud esiletõstetud, populaarsete, hinnangute alusel | hiljutised, vaated ja ajastus. Ma nägin paari kaebust, et see muudatus neile ei meeldinud, nii et kõigile: siin me muudame

Seisake lastele IPhone'i vaatamiseks lennukis: 4 sammu

Alus lastele, et vaadata lennukit iPhone'is: see juhend on mõeldud iPhone'i aluse ehitamiseks, mida vanemad saaksid lennukis kasutada telefoni hoidmiseks salvelaual. See on valmistatud kid knex'ist, mis on mõnel lapsel olemas. See kindlustab telefoni lennuki salvelaual heas vaatamisasendis ja