Readme.md es una excelente práctica

Apuntes!

Así quedo mi README

Resumen del curso de Github
Summary: Curso Profesional de Git y Github

EL README de mi Perfil

Se que le falta algo de información pero tranquilos, tranquilos primero es git y github ya después es inteligencia y mas cosas locas, lo importante es que me he vuelto un experto en esto de los readme jeje XD.

ya hablando enserio, he encontrado un monto de formas para hacer muchas cosas locas que hacen que se vea super bonitos los readme de hecho hice un Tutorial de los comandos para hacer un readme por si desean verlo.

También estoy indeciso si de hacer un tuto en los post de este curso para mostrar como estilizar los readme mas alla de los comandos del markdown “,md” pero no se ¿que Opinan ustedes?

Toolbox para crear README

Inspiración
Laravel
Vue
Ghost
Herramientas
📑Editor de archivos MD
🏅Editor de medallas
💚Repo de emojis

Apuntes 😊

En este vídeo, explican Markdown, de una manera sencilla https://www.youtube.com/watch?v=y6XdzBNC0_0

La solución que realice
https://github.com/Jonesh05/Hyperblog

Para los que no sepan, desde Visual Studio Code también pueden trabajar su ReadMe.md y ver el Preview de como esta quedando su documento, solo deben oprimir ctrl+k v en Windows o Linux o comand +k v para Mac

Por fin se para que sirve ese bendito archivo README.md

En vscode yo suelo usar la extension https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced
ya que permite ver de mejor manera como se ve el contenido que escribo en mark down ya en github o gitlab.

Estas son las paginas que Freddy utilizó para los emojis:
http://getemoji.com/
https://emojipedia.org/

Entendí esa referencia asjdasjdaj
Con amor, niñita

Este curso es el santo grial de tener un buen portafolio en GitHub … Es que podemos hacer de todo y se verá fantástico!

✨ README nos permite definir la descripción de nuestro repositorio, este suele ser el primer elemento que verá un visitante cuando entre.

Readme.md está basado en un formato de escritura conocido como Markdown. Si quieren aprender un poco más vayan al siguiente enlace: https://platzi.com/clases/1650-prework/21969-como-crear-un-buen-readmemd-y-sintaxis-de-markdown/

Me inspiré un cometario para dejar así mi Readme: para recordar que en marzo de 2022 estoy tan solo al inicio, y con mucho por mejorar y aprender, del largo camino de la programación, que estoy seguro me llevará muy lejos y me traerá grandes satisfacciones.

hola, ya se como escribir aqui!!! Ya era hora

listo

Asi quedo mi repositorio ahora.

Cómo se hace acá para poder subir freaking imágenes?? Nunca he podido. RAYOOS!!

para salir de vim también se puede usar el comando:
:wq

donde la w significa write changes “guardar cambios”.
y la q significa “quit” salir.
los 2 combinados le dan la orden a vim de Guardar y luego salir.

Mis primeros inicios con el código (sin tenerlo tan claro) fueron en Wikipedia cada que hacía una edición y la modificaba desde “el código” 😃 Que belleza.

Lo interesante de Markdown es que funciona en muchas páginas, por ejemplo la edición en Wikipedia; es un lenguaje intermedio que no es HTML, no es texto plano, es una manera de crear excelentes texto formateados.

aqui me doy cuenta de que poca creatividad tengo para hacer algo bonito jajaja

De verdad no me arrepiento de haber pagado Platzi, nos enseña lo que la Universidad no, lo mejor, muy didactico, practico, como deberia ser.
Estudiar deberia ser un deleite, Platzi lo hace de esta manera

Les comparto una guia muy breve, concisa y completa que hice sobre el uso de markdown
Aclaro que no es un instructivo como tal, pero en el use la mayoria, sino es que todas las sintaxis existentes en md es muy util ya que solo buscas la sintaxis que quieres usar y ves como usarla.

Comentar sobre tu proyecto ayuda a mas gente no solo a saber que estas haciendo sino que ellos pueden aprender de ello y he allí la importancia del README.md

Si el README.md no es bonito, nadie entrará o soy solo yo jajaja, Genial!

También modifique el README de mi perfil en Github: @CabosManuel

En los comentarios dentro del archivo README puse los links de referencia a todos los badge o botones e imágenes que usé para personalizarlo así 😄. (10h de modificaciones xD)

Buenas, les aporto este editor: https://stackedit.io/app#

Atom tiene un plugin integrado para ver la preview del markdown, solo tienen que darle a ctrl + shift + m con el archivo markdown abierto

Duda resuelta. Siempre me pregunte para que era el Readme.md

genial por el aporte

Ejemplo de un buen Readme.md https://gist.github.com/Villanuevand/6386899f70346d4580c723232524d35a

Excelente explicación y editor de readme.md, y temas del curso.
Esas mútiples personalidades de freddy son de lo mejor jaja

Excelente clase para modificar el readme

Genial!

Markdown es la misma forma en la que se escriben comentarios acá, también está la documentación

https://www.markdownguide.org/

Mi README:
https://github.com/fsolerX/hyperblog

Que interesanrte

• hola

Pueden crear notas de los cursos en Notion y se hace más facil escribir en markdown, también pueden subir sus notas para guardarlas y verlas en cualquier momento en GitHub.

He creado varios repositorios, el primero fue presisamente un README.md sobre html que pueden ver en mi github 😃

pero ahora llevo algo mas estruturado con mis apuntes de git y github, comandos y todo lo que hemos visto a partir de la terminal de comandos, me parecio interesante realizar unos apuntes en .md

interesante>
Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:

Simple, fast routing engine.
Powerful dependency injection container.
Multiple back-ends for session and cache storage.
Expressive, intuitive database ORM.
Database agnostic schema migrations.
Robust background job processing.
Real-time event broadcasting.

Muy Chevere para poder editar Readme.md
para que las personas puede entender sobre que de es el nuestro proyecto

Impresionante clase, ahora conozco dos herramientas que me ayudaran a crear estupendos archivos Readme que son el Editor.md para tener la previsualización de los cambios y el Getemoji.com para buscar los emojis que quiera y añadírselos a la portada del repositorio.

Aqui dejo mi readme.md https://github.com/FapCod/HyperBlog

Excelente, ahora aprendí usar mejor GitHub, edité los readme de mis proyectos en GitHub, te da un perfil mucho mas profesional.

Modifique mi Readme.md
Que emoción!!!

README.md es una excelente práctica en tus proyectos, md significa Markdown es un especie de código que te permite cambiar la manera en que se ve un archivo de texto.

Para hacer un template para issues se coloca “issues_template.md” o para pull requests se coloca ”pull_requests_template.md” , se coloca la extension .md (mark down):

• Para hacer un título se coloca ## título de ejemplo.
• Para hacer una lista para seleccionar se coloca “- [ ] ejemplo”.
• Para colocar texto normal, se coloca sin más el texto.

Readme.md es la descripción de lo que hace el proyecto. Es decir la información del proyecto en como funciona y también describe las parte de cada contribuidor ha realizado en el repositorio. Entre otras cosas mas, el Read.md es libre para agregar cosas especificas que quieres que sepan otras personas acerca de tu proyecto.

Por así decirlo el Readme.md es una vista por arriba de nuestro proyecto donde se da información sobre el mismo.

direccion del editor

https://pandao.github.io/editor.md/en.html

Muy buen editor de README: https://pandao.github.io/editor.md/en.html

El README es la carta de presentación de cada repositorio, por tanto aprender a crear un buen REAME, claro, conciso, detallado y visualmente bien elaborado es un plus para nuestro portafolio.

Con la tecla ventana + .(punto) en muchos de los editores se puede abrir el listado emojins

Saludos 👨🏼‍💻

Los README.md pueden estar en todas las carpetas, pero el más importante es el que se encuentra en la raíz y ayudan a que los colaboradores sepan información importante del proyecto, módulo o sección, puedes crear cualquier cualquier archivo con la extensión .md pero sólo losn README.md los mostrará por defecto GitHub.

que genial asi termina colocando de forma mas profesional tus proyectos.

Mi editor de markdown favorito es typora

Ya casi por terminar el curso 😃

Totalmente maravillado con esta herramienta.

Otro muy buen editor para tu Readme.md es

Excelente editor, yo uso vscode, pero no esta demas probar

Buena clase pero implete lo del editor online y me aparecio feo en github pero le añadi html y me salio perfecto

Excelente explicación y editor de readme.md, y temas del curso.

Excelente…1!!

excelente la forma de modificar el proyecto cada vez me siento mas profesional

Este curso es hermoso

Siempre me pregunté como hacian esas descripciones en los repositorios, excelente clase!

No tenia la idea , de la importancia de Readme.md

Excelente clase, ahora a seguir utilizando siempre los readme.

Inspirarse en proyectos Open Source

Excelente explicación y recursos. Gracias!

Ahora si me quedo mas claro Readme.md. De ahora en adelante todos mis repositorios tendran Readme.md .

Te lo prometo Freddy. Lol , xD

Hora de crear README.md para todos mis proyectos personales.

que genial, yo pense que los archivos read me solo eran .txt o planos

Excelente.

¿Cómo funciona el Markdown?

Yo me pregunto ¿alguien escribió a mano todo el README.md? Porque yo no XD
Mi confiable CRTL + C CTRL + V

muy emocionante. yo pensé que solo se ponía texto plano y ese editor de README.md funcionaba como un word

Las personalidades multiples de freddie, jajajajjaa.

1:01 Readme.md es prácticamente la representación del repositorio

El Redme es como la carta de presentación de nuestro repositorio en github, tener un buen Readme sin duda traerá estrellas a tu repo !

#Ooooh.
Así que de esta manera es que los comentarios de acá, pueden tener formato. 🤯

readme.md = el md significa ( markdown = Reduccion )

Para trabajar los readme de mis repo usas dillinger.io

Muy beno

Yo para editar markdown uso un software llamando Typora, esta disponible para varios sistemas operativos y es MUUY bueno. Cada que vaz que das enter que previsualiza lo que escribiste. Así que puedes ver el mardown que escribes en tiempo real sin necesidad de tener un panel lateral ocupando espacio como ocurre en Visual Studio Code

una excelente guia
https://www.markdownguide.org/basic-syntax/

Lo importante es la intención XD. Veo que Esta seción de aportes se parece un poco de cuando se edita en .md

Clase 33 – Readme. md es una excelente práctica

¿Usar el archivo Readme. md se considera buena práctica?

• Sí.

¿Qué significa la extensión .md?

• Markdown.

¿Para qué nos sirve Markdown?

• Para cambiar la apariencia de un archivo de texto.

¿Cómo podemos aprender a usar el archivo Readme. md?

• Inspirándonos de proyectos en GitHub

¿Para qué usamos el archivo Readme. md?

• Para contarle al mundo de que trata un repositorio, algo así como una descripción.

¿En qué lugar debemos de almacenar el archivo Readme. md?

• En la raíz de nuestro repositorio.

¿Podemos agregar código HTML a un archivo Readme. md?

• Sí.

¿La Wikipedia usa Markdown para editar su contenido?

• Sí.

Comparto mis apuntes

Me siento una pro de git y github

la clase que me hizo querer aprender HTML 😄

¡Apuntes!
Esta clase repasó:

1. Qué es un README. md:
   En un primer momento hay que ver que este documento es de tipo .md, es decir, es un documento markdown. Permite caracterizar, hasta cierto punto, el texto o información que este contenga.
   Un documento README .md es la referencia que deben tener todos los repositorios en el cual se resumirán las características más relevantes del repositorio. Es considerado una buena práctica.

Por último, a modo de consejo, es buena idea SIEMPRE estar consultando repositorios públicos (en especial proyectos Open Source) pues da muchas ideas acerca de como organizar/modificar el repositorio.

Buena pagina la de crear el readmemd , muy util

Lastima que no puedo compartir imágenes acá o tan solo no sé como es que hacen los demás
.
.
.
FFFFFFFF
F
FFFFF
F
F

Mi Readme