Welcome to the "Readme generation" Hackathon!

In the fast-paced world of software development, we often spend more time formatting documentation than writing the actual code. This hackathon challenges you to flip the script. Your mission is to focus purely on building functional, high-quality code and let automation handle the presentation.

The Theme: SDG 3 (Good Health and Well-being)

We are aligning our efforts with the United Nations Sustainable Development Goal 3. Whether it's mental health support, fitness tracking, medical resource allocation, or disease awareness, we want you to build a project that makes a tangible impact on global health.

What makes this special?

You are tasked to build a code based project repository e.g flask, python, next.js etc revolving around SDG 3 without a README file. Instead, you will use the PresentMeApp to automatically analyze your code and generate a professional presentation. This emphasizes clean, readable code and efficient development workflows.

How to Participate

Follow these 4 simple steps to build, document, and submit your project:

Step 1: Build for SDG 3

Develop a project related to SDG 3 (Good Health and Well-being) using any programming language(e.g food connection site etc). Ensure your code is clean and modular, but do not add a README file to your repository.

Step 2: Host on GitHub

Push your project code to a public GitHub repository. Ensure your folder structure is organized (e.g., separate your components, logic, and assets) so the AI can accurately interpret your work.

Step 3: Generate Documentation

Head over to the PresentMeApp GitHub repo analyzer. Pro-tip: All participants get 1-month of Enterprise to access advanced analysis features—use your Success Kit code SDG-AWARD at checkout!

Also, check out github education page for amazing tools for your projects.

Step 4: Submit your Project

Submit the link to your GitHub repository and your generated presentation link on the Devpost submission page before the deadline.

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