Obsah:

Lepší způsob prohlížení/dokumentování souborů na pokynech: 4 kroky
Lepší způsob prohlížení/dokumentování souborů na pokynech: 4 kroky

Video: Lepší způsob prohlížení/dokumentování souborů na pokynech: 4 kroky

Video: Lepší způsob prohlížení/dokumentování souborů na pokynech: 4 kroky
Video: 2023 0612 Moodle pro KBP 1 2024, Listopad
Anonim

Lidé tam často přidávají soubory projektu prostřednictvím nahrání Instructables.

Často se jedná o zdrojové soubory softwaru, které mohou být dokonce tlukoucím srdcem instruktážního programu. Ale Instructables nedává čtenáři snadný způsob, jak číst a kontrolovat kód. (Obvykle byste museli stáhnout kód, případně rozbalit, pak najít správný program pro prohlížení.) Často se ukáže, že kód, který jsem našel, nestojí za námahu. Co třeba metoda zobrazení jedním kliknutím (+- 2)? Takhle.

(Nad obrázkem z:

Nástroje a zásoby:

  • Počítač
  • Veřejný bezplatný účet GitHub

Krok 1: Zobrazení starého stylu

Prohlížení starého stylu
Prohlížení starého stylu

Docela dávno jsem napsal instrukci na chytrém terminálu pro použití s Arduinos a dalšími mikrokontroléry. Můžete to vidět zde: Python terminál pro levné připojení Pi Arduino

Sekce souborů většinou vypadá jako na výše uvedeném obrázku, pokud kliknete na soubory, stáhne se vám pokazený název souboru a potřebujete trochu počítačového tance, abyste jej otevřeli a přečetli. Poté musíte sledovat soubor ve svém počítači.

Krok 2: Zobrazení nového stylu

Prohlížení nového stylu
Prohlížení nového stylu

Zde vaše soubory kódu vypadají jako kód. Soubory-p.webp

Jak to udělat:

Stačí přidat odkaz do vašeho úložiště github. a po vykreslení instructables to vypadá takto:

Soubory GitHub projektu

V dalším kroku máme několik podrobných obrázků o přidání odkazu z editoru instructables.

Krok 3: Vložte odkaz (Podrobnosti)

Vložte odkaz (Podrobnosti)
Vložte odkaz (Podrobnosti)
Vložte odkaz (Podrobnosti)
Vložte odkaz (Podrobnosti)
Vložte odkaz (Podrobnosti)
Vložte odkaz (Podrobnosti)
Vložte odkaz (Podrobnosti)
Vložte odkaz (Podrobnosti)
  • Obrázek 1: Klikněte na ikonu odkazu (zvýrazněno).
  • Obrázek 2: Zobrazí se dialogové okno odkazu.
  • Obrázek 3: Vyplňte dialogové okno.
  • Obrázek 4: A dostanete pěkný odkaz ve vašem pokynu.

Pokud by to udělal každý, bylo by mnohem snazší zobrazit kód (a jiné typy souborů) a dokonce stáhnout celou sadu souborů jako pěkný zip soubor s interními názvy a zachovanou strukturou adresářů.

To se mi tak líbí, že se vrátím a opravím všechny své staré instruktáže!

Krok 4: Související odkazy

  • 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/
  • Terminál Python pro levné připojení Pi Arduino

Doporučuje: