Hacker News new | ask | show | jobs
by mayapugai 1690 days ago
Hey, this is a great project. I am working on a project that involves both hardware and software much like your CNC project.

I especially like how the README.md is exquisitely well-written, complete with images. May I ask - did you manually link the pictures and links while writing the README or did you use a program that let you generate the source md file from a WYSIWYG editor?

PS. I am a newbie here. So, I really hope this question isn't against the code of conduct here.

2 comments

There are a limited number of ways you can link your images on a Github README. The format is the same for all methods.

![image description](image.png)

1. You might upload to a bucket online and link them individually.

![image]https://cdn.bucket.url/image.png)

2. Upload the images to your Github repo in a folder and relatively link them.

![image](./images/image.png)

3. Edit your README on the WYSIWYG editor on Github itself and paste the images using Ctrl+V. Github will automatically host and link the image in your file.

I hope this has been helpful!

Your polite and inquisitive message exemplifies the code of conduct here :) Welcome!