84 lines
2.9 KiB
Markdown
84 lines
2.9 KiB
Markdown
<p align="center">
|
||
<img alt="oss image" src="./imgs/zoss-logo.svg" height="200px" width="200px">
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://twitter.com/intent/tweet?text=How%20to%20promote%20your%20open-source%20projects&url=https://github.com/zenika-open-source/open-source-promotion-cheat-sheet&hashtags=OpenSource,CheatSheet">
|
||
<img alt="tweet" src="https://img.shields.io/twitter/url/https/twitter?label=Share%20on%20twitter&style=social" target="_blank" />
|
||
</a>
|
||
</p>
|
||
|
||
<h1 align="center">Cheat sheet : Comment promouvoir un projet open-source ?</h1>
|
||
|
||
> Ce cheet sheet résume les étapes importantes à suivre pour promouvoir un projet open-source dans les meilleurs conditions. Il est possible d’afficher des informations supplémentaires pour un élément de la liste en cliquant dessus.
|
||
|
||
Langages disponibles :
|
||
|
||
- [English](./README.md)
|
||
- [Français](./README-fr.md)
|
||
|
||
Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat sheet ? [Les contributions sont les bienvenues](./CONTRIBUTING.md) !
|
||
|
||
## 1. 🎢 Étape de préparation
|
||
|
||
<br />
|
||
|
||
<details>
|
||
<summary>😎 Choisir un nom cool pour son projet</summary>
|
||
<p>
|
||
|
||
> Choisissez un nom que vos visiteurs pourront facilement retenir.
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>💅 Soigner la présentation du README</summary>
|
||
<p>
|
||
|
||
> Le README est la première choses que les visiteurs verront sur la page de votre projet. Travaillez la présentation pour qu'elle soit simple, jolie et agréable à lire. [Vous trouverez des exemples de README soignés ici.](https://github.com/matiassingers/awesome-readme)
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>💪 Mettre en avant les points fort du projet</summary>
|
||
<p>
|
||
|
||
> Identifiez les points forts de votre projet et mettez les en avant de manière à ce que ce soit la première chose que voient vos visiteurs.
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>✨ Mettre une démo du projet à disposition</summary>
|
||
<p>
|
||
|
||
> Vos visiteurs voudront comprendre rapidement à quel besoin répond votre projet et comment il fonctionne. Mettre une démo à disposition est un excellente moyen de satisfaire vos visiteurs. Le format de la démo peut être :
|
||
>
|
||
> - un GIF animé
|
||
> - un lien vers un démo en ligne
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>👌 L'installation et l'utilisation du projet doit être la plus simple possible</summary>
|
||
<p>
|
||
|
||
> Vous risquez de perdre des visiteurs si le projet n'est pas simple à installer/utiliser.
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>📘 Créer une documentation soignée et structurée</summary>
|
||
<p>
|
||
|
||
> Créer un bonne documentation est probablement l'étape la plus importante. Si votre documentation n'est pas longue, vous pouvez l'inclure directement dans votre README. Si celle-ci est volumineuse, le mieux sera de l'héberger sur un site différent. Certains projets open-source comme [vuepress](https://v1.vuepress.vuejs.org) permettent de créer rapidement une jolie documentation.
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<br />
|