A problem many of us have probably experienced (or perhaps currently experiencing! 🙈) at a hackathon is that many hackers don't know what to build or how to start.
In addition, many hacks often slip through the cracks and are never touched again after the weekend ends. We want to change that by enabling hackers to share their projects on Enlight, so that any curious hacker may have a place to start as they begin to work on their idea. This is why we are offering a Best README prize, awarded to the teams that best document their hacks and can be adapted to a project that can be reproduced.
Rather than being forgotten about, it will be seen and used as a resource by thousands of developers as a starting point for their own personal projects, regardless of whether they are presently at a hackathon.
Each team member on our favorite teams* will receive a spot in Enlight's upcoming **two week Web Development Cohort launching on March 28th, 2021** (normally $99 a seat). In addition, we'll gift each winner one month of Discord Nitro so you can brag with all the animated emojis and stuff you want 😉
*multiple teams can win this prize!!!
Since we want you all to spend as much time as possible working on the hacking side of your projects, the deadline for this project will be one week after hacking ends on Sunday, February 28th. Just make sure to mark yourself for the prize on Devpost if you wish to be considered. We'll contact the winning teams with the next steps to share your project with thousands of creators and developers!!!
Your README should be straight 🔥 fire 🔥
Seriously, do a good job of walking someone through how they could remake your project. For example, say you're designing an application that tracks the sentiment of different subreddit forums on Reddit. You'll want to walk your readers through what sentiment analysis does, the libraries and languages you used, and some key code snippets with explanation of what is happening so that someone could recreate a simple version of your project.
You should introduce the project, the technology stack, and talk about how you set it up and incorporated its different aspects. You're writing in Markdown, so take advantage of the code blocks and other formatting tools. If it helps, you can focus this README around one particular feature that you built that's shippable 📦 — in other words, it could be its own standalone mini project.
If you want a good example of a successful project, check out some awesome stuff from the community at Enlight. One particularly great project you could draw inspiration from is the Build a Neural Network project!
We really couldn't title this prize Supa Hot Fire without this 🔥
you after finishing your supa hot fire README