✨ Add new points and test new presentation (#4)
This commit is contained in:
Thomas Betous
Franck Abgrall
parent
003d9b301c
commit
176124e757
102
README.md
102
README.md
|
|
@ -3,50 +3,70 @@
|
|||
> This cheat sheet summarize important steps you should follow to promote your open-source project in the best conditions.
|
||||
|
||||
List of availables languages:
|
||||
|
||||
- [English](./README.md)
|
||||
- [Français](./README-fr.md)
|
||||
|
||||
---
|
||||
|
||||
## 1. 🎢 Preparation step
|
||||
<br />
|
||||
<details open><summary><b>😎 Choose a cool name for your project</b></summary>
|
||||
<p>
|
||||
<br />
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||
<br />
|
||||
</p>
|
||||
</details>
|
||||
<details><summary><b>💅 Make your README pretty</b></summary>
|
||||
<p>
|
||||
<br />
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||
<br />
|
||||
</p>
|
||||
</details>
|
||||
<details><summary><b>✨ Provide a demo of your project</b></summary>
|
||||
<p>
|
||||
<br />
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||
<br />
|
||||
</p>
|
||||
</details>
|
||||
<details><summary><b>👌 Insall/Usage must be super easy</b></summary>
|
||||
<p>
|
||||
<br />
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||
<br />
|
||||
</p>
|
||||
</details>
|
||||
<details><summary><b>📘 Create a clean and well structured documentation</b></summary>
|
||||
<p>
|
||||
<br />
|
||||
TestLorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||
<br />
|
||||
</p>
|
||||
</details>
|
||||
<br />
|
||||
|
||||
## 2. 📢 Spread the word about your hard works
|
||||
<br />
|
||||
- 😎 Choose a cool name for your project
|
||||
|
||||
## 3. 🤝 Keep your users
|
||||
<br />
|
||||
- 💅 Make your README pretty
|
||||
|
||||
<details>
|
||||
<summary>Details</summary>
|
||||
<p>
|
||||
|
||||
> [List of beautiful readmes](https://github.com/matiassingers/awesome-readme).
|
||||
|
||||
</p>
|
||||
</details>
|
||||
|
||||
- ✨ Provide a demo of your project
|
||||
|
||||
- 👌 Insall/Usage must be super easy
|
||||
|
||||
- 📘 Create a clean and well structured documentation
|
||||
|
||||
## 2. 📢 Spread the word about your hard works
|
||||
|
||||
- ⭐ Talk about your project to your friends and colleagues to get your first stars before publishing to social networks
|
||||
|
||||
<details>
|
||||
<summary>Details</summary>
|
||||
<p>
|
||||
|
||||
> A minimum of stars make your project more trustable then a zero star project.
|
||||
|
||||
</p>
|
||||
</details>
|
||||
|
||||
- ↗️ Share the project on social medias an specialized platforms
|
||||
|
||||
- 📃 Write articles that mention your project
|
||||
|
||||
- 🕐 Take care to choose the best time to post and share articles
|
||||
|
||||
- 📘 Manage your communication to make the project be in trending pages
|
||||
|
||||
## 3. 🤝 Keep your users
|
||||
|
||||
- 🆕Try to regularly release new versions of your project
|
||||
|
||||
- ❗ Do not let issues open without answer
|
||||
|
||||
- 🙏 Invite users to contribute
|
||||
|
||||
- 🏆 Reward contributors
|
||||
|
||||
- 💬 Open a community chat platform
|
||||
|
||||
- 🔙 Ask for feedback
|
||||
|
||||
---
|
||||
|
||||
# Useful links
|
||||
|
||||
- [List of beautiful readmes](https://github.com/matiassingers/awesome-readme)
|
||||
|
|
|
|||
Loading…
Reference in a new issue