Secciones

Haga clic para editar, alterne para incluir

Título y Descripción
Insignias
Características
Pila Tecnológica
Instalación
Uso/Ejemplos
Variables de Entorno
Referencia de API
Autores
Licencia
EditorMarkdown
Vista previa en vivo

Project Title

A brief description of what this project does and who it's for.

License Version

Features

  • Feature 1
  • Feature 2
  • Feature 3

Tech Stack

Client: React, Redux, TailwindCSS

Server: Node, Express

Installation

Install my-project with npm

  npm install my-project
  cd my-project

Usage/Examples

import Component from 'my-project'

function App() {
  return <Component />
}

Authors

License

MIT

Arquitecto README ProBeta

Cree archivos README.md profesionales y completos para sus proyectos de GitHub en segundos utilizando nuestro editor visual. No se requieren conocimientos de Markdown.

Cómo usar

1

Elegir Secciones

Seleccione las secciones que necesita para su proyecto de la lista de la barra lateral.

2

Editar Contenido

Complete los detalles de cada sección utilizando el editor simple a la izquierda.

3

Exportar

Obtenga una vista previa de su README en tiempo real y descargue el archivo Markdown cuando esté listo.

Preguntas Frecuentes

¿Qué es un generador de README?

Un generador de README es una herramienta que ayuda a los desarrolladores a crear documentación profesional para sus proyectos sin formatear manualmente el código Markdown.

¿Es esta herramienta gratuita?

Sí, el Arquitecto README Pro es 100% gratuito y está abierto para que todos lo usen.

¿Necesito saber Markdown?

No, no necesita un conocimiento extenso de Markdown. Nuestra herramienta se encarga del formato por usted.

¿Puedo agregar secciones personalizadas?

Actualmente, puede editar el contenido de las secciones predefinidas. Estamos trabajando para permitir la creación de secciones personalizadas en futuras actualizaciones.

¿Cómo agrego imágenes?

Puede agregar imágenes utilizando la sintaxis estándar de Markdown: ![Texto alternativo](url). Asegúrese de que sus imágenes estén alojadas en línea.

¿Soporta emojis?

Sí, los emojis estándar de GitHub-flavored Markdown son totalmente compatibles en el editor y la vista previa.

¿Puedo usar esto para proyectos comerciales?

¡Absolutamente! Los archivos README generados son suyos para usar en cualquier proyecto, personal o comercial.

¿Cómo guardo mi trabajo?

Actualmente, la herramienta funciona en su navegador. Recomendamos descargar su README con frecuencia para guardar su progreso.

¿Es la salida compatible con GitLab/Bitbucket?

Sí, el Markdown generado es estándar y funciona en GitHub, GitLab, Bitbucket y otras plataformas de alojamiento de código.

¿Por qué es importante un README?

Un buen README es la cara de su proyecto. Ayuda a otros a entender qué hace su código, cómo usarlo y cómo contribuir.