Quick tips for permoting your open source project.
1) Make a kickass readme.
Big list of awesome examples here
2)'💪 Highlight strong points of your project' - zenika
Identify your project strengths and make sure visitors see them first. -zenika
3) Demo link or gif of project in action
4) Super easy install instructions (also for non technical users)
Dont assume someone knows something that is "obvious"
Source: of lots of the tips come from here
Creating a good documentation is probably the most important step. If you have a small documentation, you can include it within your README. Otherwise, you should probably host it in a separate website. Some open source projects like vuepress can help you creating clean documentation in a simple way.
by oran collins github.com/wisehackermonkey oranbusiness (ascii 64) gmail (ascii 46) com 20211218