DEV Community

Cover image for Has tu README realmente útil
Jairo Fernández
Jairo Fernández

Posted on

1 1

Has tu README realmente útil

Has tu README realmente útil

Muchas veces, el readme se vuelve un poco tedioso, y en ocasiones he preferido usar y abusar de scripts bash, para automatizar procesos, sin embargo, a veces puede resultar un poco difícil mantener ambas cosas, sobre todo en proyectos donde el cambio está a la orden del día, entonces, me encontré con una herramienta que ayuda a convertir los files markdown en obras maestras, muy similar a como usaríamos un Jupyter notebook!

manos a la obra,

La herramienta se llama runme, y básicamente tiene 4 modos de uso:

  • Con tu editor, por ahora solo con Vscode.

  • Vía terminal, donde puedes directamente ejecutar un comando de tu README (ya lo veremos!)

  • Vía terminal pero abriendo un servidor web, que “oh sorpresa”, es un Vscode corriendo en tu navegador.

  • Vía extensión web.

Veamos un ejemplo

Usando la extensión de Vscode: Runme DevOps Notebooks

start

Al presionar allí empezarás a ver la magia

Magic

Notarás que al acercar el mouse a una celda (sí, cada sección se llama celda como en los Jupyter notebooks)

button section

En nuestro caso, vamos a empezar con algo sencillo, escribiremos el comando

uname -a
Enter fullscreen mode Exit fullscreen mode

Y al ejecutar veremos como la salida de la terminal queda directamente en nuestro README

execution

Veamos todo junto con un ejemplo más grande como se ejecuta

all

Usando su extensión

Sigue las instrucciones para instalarla [aquí], y si vas al repositorio donde tengo el código del ejemplo anterior,

https://github.com/jairoFernandez/articles/tree/main/readme-powers

Verás un botón que te dará un link de esta forma:

https://runme.dev/api/runme?repository=https%3A%2F%2Fgithub.com%2FjairoFernandez%2Farticles.git&fileToOpen=readme-powers%2FREADME.md

Esto abrirá tu vscode y te permitirá ejecutar el Readme.

Image of Datadog

Create and maintain end-to-end frontend tests

Learn best practices on creating frontend tests, testing on-premise apps, integrating tests into your CI/CD pipeline, and using Datadog’s testing tunnel.

Download The Guide

Top comments (0)

Billboard image

The Next Generation Developer Platform

Coherence is the first Platform-as-a-Service you can control. Unlike "black-box" platforms that are opinionated about the infra you can deploy, Coherence is powered by CNC, the open-source IaC framework, which offers limitless customization.

Learn more