Quick tips for permoting your open source project.

1) Make a kickass readme.

Big list of awesome examples here

GitHub - matiassingers/awesome-readme: A curated list of awesome READMEs

A curated list of awesome READMEs. Contribute to matiassingers/awesome-readme development by creating an account on GitHub.

GitHubmatiassingers

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

promote-open-source-project/README.md at main · zenika-open-source/promote-open-source-project

📄 How to promote my open source project? Contribute to zenika-open-source/promote-open-source-project development by creating an account on GitHub.

GitHubzenika-open-source

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.

Author

by oran collins
github.com/wisehackermonkey
oranbusiness  (ascii 64)  gmail  (ascii 46) com
20211218