42.8K
B.Small tutorial for README file ↓↓
I’ve always seen other people readme files, but I never felt like I should do one since all my projects weren’t that serious. This morning though a classmate told me that there was some “conventions” about README files and I felt curious about it and I wanted to share with you how I created my first README file with the research I did:
⊹ ࣪ ˖ Save this post for later ! ⊹ ࣪ ˖
✅ A readme file is like the manual of your project, as it tells people how to have it, use it, change it etc…
Remember that this is not an exhaustive list of what you should put in your readme files, it really depends on the complexity and type of project you’re making, but this is a good start!
For lazy coders like me, there’s plenty of readme templates you can use and adapt to your own project 🙂↕️✨
<tags>
[coding, programmation, computer science, informatique, student, computer science student, coding project, GitHub profile, readme file]
#computersciencestudent #studentsuccess #studytips #womenintech #codingisfun #codingchallenge #codinggirl #studentlife #githubuniverse #codingtips #github
@b.telgeuse
![#Github Readme Reel by @nikhilhuhcodes - Your GitHub profile still looks basic? 👀
Let's convert it into THIS in just 5 minutes.
[ Step 1 ] Create a new repo with your GitHub username
[ Step](https://image.pictame.com/img/640696388_17856683175663983_7047982393323911640_n.jpg?hash=aHR0cHM6Ly9zY29udGVudC5jZG5pbnN0YWdyYW0uY29tL3YvdDUxLjgyNzg3LTE1LzY0MDY5NjM4OF8xNzg1NjY4MzE3NTY2Mzk4M183MDQ3OTgyMzkzMzIzOTExNjQwX24uanBnP3N0cD1kc3QtanBnX2UzNV9zNjQweDY0MF90dDYmX25jX2NhdD0xMTAmY2NiPTctNSZfbmNfc2lkPTE4ZGU3NCZlZmc9ZXlKbFptZGZkR0ZuSWpvaVEweEpVRk11WW1WemRGOXBiV0ZuWlY5MWNteG5aVzR1UXpNaWZRJTNEJTNEJl9uY19vaGM9VjhGanZwLTV6NU1RN2tOdndISEZ6YUYmX25jX29jPUFkcG1JaXVCNG1IUWpub2YtVm0zb0FRTEFTWWV3d1A2ZzRmZDBKaTFqNEVTNGJJVDB2QzYzNDNPaEwwUjl2aFN5S3MmX25jX3p0PTIzJl9uY19odD1zY29udGVudC5jZG5pbnN0YWdyYW0uY29tJl9uY19naWQ9Q0RTQ2dsMEhWcDJvRloyQXk4RFhIdyZfbmNfc3M9N2ZhOGMmb2g9MDBfQWY3YmtqZDIzajFTV2w5ZUpRZzZmaTM2NF9Ta3Uxem9QSUtDaVJtLWtsc21DZyZvZT02QTBBRkE5RQ==)
