Talimatlardaki Dosyaları Görüntülemenin/Belgelemenin Daha İyi Yolu: 4 Adım

2024 Yazar: John Day | [email protected]. Son düzenleme: 2024-01-30 13:18

İnsanlar genellikle Instructables yüklemeleri aracılığıyla proje için dosyalar ekler.

Genellikle bu, öğretilebilirlerin atan kalbi bile olabilecek yazılım kaynak dosyalarıdır. Ancak Instructables, okuyucuya kodu okuması ve incelemesi için kolay bir yol sağlamaz. (tipik olarak kodu indirmeniz, muhtemelen sıkıştırmayı açmanız ve ardından doğru görüntüleme programını bulmanız gerekir.) Çoğu zaman bulduğum kodun çabaya değmediği ortaya çıkıyor. Programları görüntülemek için tek tıklama (+- 2) yöntemine ne dersiniz? Bu nasıl.

(Yukarıdaki resim:

Araçlar ve Malzemeler:

• Bilgisayar
• GitHub herkese açık ücretsiz hesap

Adım 1: Eski Stili Görüntüleme

Bir süre önce Arduinos ve diğer mikrodenetleyicilerle kullanım için Akıllı Terminalde bir talimat yazdım. Burada görebilirsiniz: Ucuz Pi Arduino Bağlantısı için Python Terminali

Dosya bölümü çoğunlukla yukarıdaki resme benziyor, eğer dosyalara tıklarsanız karışık bir dosya adıyla bir indirme elde edersiniz ve açıp okumak için biraz bilgisayar dansı yapmanız gerekir. Ardından, bilgisayarınızda dosyayı takip etmeniz gerekir.

2. Adım: Yeni Stili Görüntüleme

Burada kod dosyalarınız kod gibi görünür.-p.webp

Nasıl yapılır:

Sadece github deponuza bir bağlantı ekleyin. ve bir kez talimatlar tarafından oluşturulduktan sonra şöyle görünür:

Projenin GitHub Dosyaları

Bir sonraki adımda, talimat düzenleyicisinden bağlantı eklemenin bazı ayrıntılı resimlerine sahibiz.

3. Adım: Bağlantıyı Ekleyin (Ayrıntılar)

• Resim 1: Bağlantı Simgesine (vurgulanmış) tıklayın.
• Resim 2: Bağlantı iletişim kutusunu alırsınız.
• Resim 3: İletişim kutusunu doldurun.
• Resim 4: Ve öğretilebilir dosyanızda güzel bir bağlantı elde edersiniz.

Herkes bunu yapsaydı, kodu (ve diğer dosya türlerini) görüntülemek ve hatta tüm dosya setini dahili adları ve dizin yapısı korunmuş güzel bir zip dosyası olarak indirmek çok daha kolay olurdu.

Bunu çok beğendim, geri dönüp tüm eski talimatlarımı düzelteceğim!

4. Adım: İlgili Bağlantılar

• 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/
• Ucuz Pi Arduino Bağlantısı için Python Terminali