Tabla de contenido:

Mejor manera de ver / documentar archivos en Instructables: 4 pasos
Mejor manera de ver / documentar archivos en Instructables: 4 pasos

Video: Mejor manera de ver / documentar archivos en Instructables: 4 pasos

Video: Mejor manera de ver / documentar archivos en Instructables: 4 pasos
Video: ORGANIZACIÓN Y ARCHIVO DE DOCUMENTOS - GESTIÓN DOCUMENTAL 2024, Noviembre
Anonim

Las personas a menudo incluyen archivos para proyectos a través de cargas de Instructables.

A menudo, se trata de archivos fuente de software que incluso pueden ser el corazón palpitante del instructable. Pero Instructables no le brinda al lector una manera fácil de leer y revisar el código. (por lo general, necesitaría descargar el código, posiblemente descomprimirlo y luego encontrar el programa de visualización correcto). A menudo, el código que he encontrado resulta que no vale la pena el esfuerzo. ¿Qué tal un método de un clic (+ - 2) para ver los programas? Así es como.

(Imagen superior de:

Herramientas y suministros:

  • Computadora
  • Cuenta pública gratuita de GitHub

Paso 1: Ver estilo antiguo

Ver estilo antiguo
Ver estilo antiguo

Hace bastante tiempo escribí un instructivo en un terminal inteligente para usar con Arduinos y otros microcontroladores. Puede verlo aquí: Terminal Python para conexión Pi Arduino barata

La sección de archivos se parece principalmente a la imagen de arriba, si hace clic en los archivos, obtiene una descarga con un nombre de archivo destrozado y necesita hacer un pequeño baile de computadora para abrirlo y leerlo. Luego, debe realizar un seguimiento del archivo en su computadora.

Paso 2: Ver estilo nuevo

Ver nuevo estilo
Ver nuevo estilo

Aquí sus archivos de código se ven como código. Los archivos-p.webp

Cómo hacerlo:

Simplemente agregue un enlace a su repositorio de github. y una vez renderizado por instructables se ve así:

Archivos de GitHub del proyecto

En el siguiente paso, tenemos algunas imágenes detalladas de cómo agregar el enlace desde el editor de instrucciones.

Paso 3: inserte el enlace (detalles)

Inserte el enlace (detalles)
Inserte el enlace (detalles)
Inserte el enlace (detalles)
Inserte el enlace (detalles)
Inserte el enlace (detalles)
Inserte el enlace (detalles)
Inserte el enlace (detalles)
Inserte el enlace (detalles)
  • Imagen 1: Haga clic en el icono de enlace (resaltado).
  • Imagen 2: Obtiene el cuadro de diálogo de enlace.
  • Imagen 3: Complete el cuadro de diálogo.
  • Imagen 4: Y obtienes un buen enlace en tu instructable.

Si todo el mundo hiciera esto, sería mucho más fácil ver el código (y otros tipos de archivos, e incluso descargar todo el conjunto de archivos como un bonito archivo zip con los nombres internos y la estructura de directorios conservada.

¡Me gusta tanto que voy a volver y arreglar todos mis viejos instructables!

Paso 4: Enlaces relacionados

  • 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/
  • Terminal Python para conexión Pi Arduino barata

Recomendado: