Github readme generation

The challenge

Build a code-based project repository revolving around SDG 3 (Good Health and Well-being) without a README file. Instead, use the PresentMeApp to automatically analyze your code and generate a professional presentation.

How to Participate

1. Build for SDG 3: Develop a project related to SDG 3 (Good Health and Well-being) using any programming language. Ensure your code is clean and modular, but do not add a README file to your repository.
2. Host on GitHub: Push your project code to a public GitHub repository. Ensure your folder structure is organized.
3. Generate Documentation: Use the PresentMeApp repo analyzer to generate a presentation. Participants receive a 1-month Enterprise access with voucher code SDG-AWARD.
4. Submit your Project: Submit the link to your GitHub repository and your generated presentation link on the Devpost submission page.

Required tech & constraints

• Eligibility: Students only. Companies/professional organizations are excluded. Must be of legal age of majority in country of residence. All countries/territories eligible, excluding standard exceptions.
• Codebase: Must be a link to a public GitHub repository without an initial README file.
• Documentation: Must include a link to the presentation/README generated via the PresentMeApp.
• Project Focus: Codebase must clearly demonstrate a solution or tool related to SDG 3 (Good Health and Well-being).
• Description: A short summary on Devpost explaining the problem your project solves and how it fits the SDG 3 theme.

Submission requirements

• Link to a public GitHub repository (without initial README).
• Link to the presentation/README generated via PresentMeApp.
• Description on Devpost explaining the project and its relation to SDG 3.

Judging Criteria

• Github uploaded code (30 marks): Was the code successfully uploaded on GitHub?
• Presentme Repo Analyzer (40 marks): Was the code analyzed using Presentme Repo Analyzer to generate a readme?
• Relations to team (20 marks): Was the code/project related to SDG 3?
• Neatness of code (10 marks): Was code well arranged in a quality manner?

Prizes

• Official Participant Success Kit (998 winners): GitHub Student Pack: Tools, 1-month PresentMe Enterprise access (Code: SDG-AWARD), Official Certificate, Exclusive Newsletter.
• Runner Up (2 winners): Certification, 2-month PresentMe Premium voucher.
• Grand Prize Winner (1 winner): Certification, 2 months renewable PM voucher coupon, Optional mentoring session.