search

anitab-org / stem-diverse-tv

STEM Diverse TV is a project which gather and provide inspiring, motivating, informative, educational and supportive videos about diversity in STEM. This is a backend which provide content for multiple frontend applications build with Applicaster Zapp platform.
https://stem-diverse-tv.herokuapp.com/
GNU General Public License v3.0
13 stars 49 forks source link

Doc: Improve the Setup and run section in README.md #254

Closed Abjcodes closed 2 years ago

Abjcodes commented 2 years ago

Description

Currently, the Setup and run section of the README file is unlabeled. Add numbers and bullets to make it more readable and organized.

To Reproduce

Steps to reproduce the behavior:

  1. Go to README.md
  2. Scroll down to 'Setup and run section'
  3. Add numbers and bullet points (if necessary)

Additional context

You can refer to the README.md files of mentorship-backend and anitab-forms-web to get an idea about the structuring the Setup and run section

welcome[bot] commented 2 years ago

Hello there!👋 Welcome to the project!💖

Thank you and congrats🎉for opening your very first issue in this project. AnitaB.org is an inclusive community, committed to creating a safe and positive environment.🌸 Please adhere to our Code of Conduct.🙌 You may submit a PR if you like! If you want to report a bug🐞 please follow our Issue Template. Also make sure you include steps to reproduce it and be patient while we get back to you.😄

Feel free to join us on AnitaB.org Open Source Zulip Community.💖 We have different streams for each active repository for discussions.✨ Hope you have a great time there!😄

znamazbayeva commented 2 years ago

Hello! Can you assign this issue to me?

vj-codes commented 2 years ago

Assigning you @znamazbayeva Happy documenting!

znamazbayeva commented 2 years ago

@Abjcodes @vj-codes I have submitted PR :tada: please kindly, review.