61: Enhance repository documentation regarding project setup and execution #67
Conversation
add: requirements and introduction
fix: some .md problems
fix: some minor text problems
feat: more adjusts on readme
fix: capital letters
refactor: minor adjustments
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
add: some minor problems
add some lines to make more readable
Luana-ns
requested review from
marco-souza,
frattezi,
nicolasbrandao,
vitorschelb,
guilherme-bbsa and
wfabi0
There was a problem hiding this comment.
Hey folks, thank you for solving the issues I previously pointed out. I recommend installing the extension I've mentioned and do a quick lint over all the files in the PR, thank you!
Also, can you please add more meaningful names for the images? You can change the example-images folder names and patterns like this:
images/
- contribution-guidelines/
- descriptve-image-name.pngPlease note the changes I'm asking:
example-imagesnow is calledimages.- We have a folder for each file the images belong to
- Images have descriptive names, to be easily identified.
Thank you 🚀 We are almost there!
There was a problem hiding this comment.
I love the work you have put on this task guys, NOW WE HAVE A README!!
Awesome work, thank you a lot for being so patient and quickly answering the conversations here in the PR, you did amazing!
Lets go with the merge! 
@Luana-ns @ogatalars
Description
This PR aims to improve and expand the project's README documentation. The current README provides a basic overview, but it lacks comprehensive information that would be beneficial to both developers and users. This update is focused on making the README more informative, user-friendly, maintainable and engaging.