Skip to content

README.md update #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 17, 2024
Merged

README.md update #6

merged 2 commits into from
Jun 17, 2024

Conversation

navalex
Copy link
Contributor

@navalex navalex commented Jun 17, 2024

Updating the README.md file to add and improve it.

  • Add TOC to ease navigation in the doc
  • Rewrite the install guide to separate the 3 parts with a maybe easier code
  • Add a Docker image part to use my docker image to ease the whole process

I would also give you 2 suggest that i prefered not touch without check with you:

  • I don't think this README is the best place to make some advertise for your job looking, or at least not at the top, would be better at the EOF
  • The present image is cool but it take all the page to display, and you don't fall directly on the doc. You should maybe add a link to "check how it looks like", to make the README lighter

In any case, thanks for your work ! 🥇

@navalex
Copy link
Contributor Author

navalex commented Jun 17, 2024

Related to #5

@LovesWorking
Copy link
Owner

Updating the README.md file to add and improve it.

  • Add TOC to ease navigation in the doc
  • Rewrite the install guide to separate the 3 parts with a maybe easier code
  • Add a Docker image part to use my docker image to ease the whole process

I would also give you 2 suggest that i prefered not touch without check with you:

  • I don't think this README is the best place to make some advertise for your job looking, or at least not at the top, would be better at the EOF
  • The present image is cool but it take all the page to display, and you don't fall directly on the doc. You should maybe add a link to "check how it looks like", to make the README lighter

In any case, thanks for your work ! 🥇

This looks amazing great job! You can make any of those changes you suggested and more.

Thanks!!

@navalex
Copy link
Contributor Author

navalex commented Jun 17, 2024

Updating the README.md file to add and improve it.

  • Add TOC to ease navigation in the doc
  • Rewrite the install guide to separate the 3 parts with a maybe easier code
  • Add a Docker image part to use my docker image to ease the whole process

I would also give you 2 suggest that i prefered not touch without check with you:

  • I don't think this README is the best place to make some advertise for your job looking, or at least not at the top, would be better at the EOF
  • The present image is cool but it take all the page to display, and you don't fall directly on the doc. You should maybe add a link to "check how it looks like", to make the README lighter

In any case, thanks for your work ! 🥇

This looks amazing great job! You can make any of those changes you suggested and more.

Thanks!!

Nice, well I changed the image to be just a link, and move your catch-phrase at the end of the file :)
If it's good for you, you can merge it, don't think I missed something

@LovesWorking LovesWorking merged commit 149aa3a into LovesWorking:main Jun 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants