• Markdown is a lightweight markup language. It allows you to style a digital text document using typical formatting techniques: for example, headings, emphasis, lists, images, and links. Markdown files have extensions .md or .markdown. Also, Markdown can also be converted into XHTML or HTML to display nicely in a browser.

• Some of the many uses of Markdown are readme files, writing messages in online discussion forums, creating rich text using a plain text editor, emails, and technical documentation. Popular sites that use Markdown include GitHub, Trello, Reddit, SourceForge, and StackExchange, among many others.

• Writers can have as much control over the presentation of their information without resorting to complete HTML tagging. At the same time, Markdown parsers also support dropping in blocks of HTML code that add to Markdown’s limited syntax if you want to achieve a more complex design.

Why use Markdown?

• It makes it easier for non-tech writers to produce documentation that can be collaborative and flexible at the same time.

• You don't even have to be a developer to pick up the basics. The advantage of Markdown is that it's straightforward to write once you know how it works. It's intuitively easy to pick up because it has a base of email formatting conventions that many people are exposed to already.

• You can also easily read Markdown in its raw state, unlike, for example, plain HTML, which is full of tags. The Markdown syntax flows perfectly with the rest of your writing, and it's intuitively clear what the syntax means.

• Markdown is platform-independent, which means you can create Markdown files in any text editor. It's applicable across many different websites and applications.

• It's a reusable skill. Markdown is versatile, so you learn it once, and you can use it for lots of different activities. You can use Markdown to take notes, create content for a website, or produce print-ready documents.

Basics of Markdown

Syntax highlighted code block

# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6


- Bulleted
- List

1. Numbered
2. List

**Bold** and _Italic_ and `Code` text

[Link](url) and ![Image](src)

Headings

All Markdown files should contain headers. You need a level 1 header for the title of your Markdown file, and at least level 2 headers for the subheadings within the body text. Headings make your text more readable and help to break up the topics.

In Markdown, headings are formatted with hashes (#) in front of the line containing your heading. You can use up to six hashes, with the number of hashes corresponding to a heading level.

# Heading level 1
## Heading level 2
### Heading level 3
#### Heading level 4
##### Heading level 5
###### Heading level 6

Your text will look like this:

Heading level 1

Heading level 2

Heading level 3

Heading level 4

Heading level 5

Heading level 6

Paragraphs

When writing your Markdown body text, you’ll likely want to split your information up into paragraphs (with a noticeable gap between each paragraph). Paragraphs are divided by a blank line (a line containing no characters) between consecutive paragraphs.

Your text will look like this:

Paragraph 1

Paragraph 2

Line breaks

Sometimes, you’ll want to split your information up by inserting a new line, with less space than you’d get from formatting as a paragraph. This is called a line break.

To insert a line break into your Markdown file, finish your line with at least two spaces and press return. This will render a new line for your text.

Your text will look like this:

Line 1
Line 2

Formatting text in Markdown

To format the text, follow these rules:

- For italics, wrap the item with one star on each side: *one star on each side*.
- For bold text, wrap the item with two stars on each side: **two stars on each side**.
- For striking through text in GitHub Markdown, wrap the item in two tildes: ~~strikethrough~~.
- For links, wrap link text in brackets [ ], and then wrap the URL in parentheses ( ): [This text links to Markdown](https://sushreesatarupa.github.io/Markdown/).

• The formatted text will look like this:
• For italics, wrap the item with one star on each side: one star on each side.
• For bold text, wrap the item with two stars on each side: two stars on each side.
• For striking through text in GitHub Markdown, wrap the item in two tildes: strikethrough.
• For links, wrap link text in brackets [ ], and then wrap the URL in parentheses ( ): This text links to Markdown.

Emphasis

When writing your content in Markdown, you might want to place a bit more emphasis on certain words or phrases. The first way you can emphasise your text is in italics.

You can make your text italic by wrapping your text with one asterisk on each side (alternatively, you can use underscores in place of the asterisks). Once your application detects the second asterisk, your formatting for this element is considered “closed”.

Your text will look like this:

• This text is italic
• This text is also italic

Bold formatting provides a slightly heavier emphasis than italics, but it works in exactly the same way. This time, use two asterisks to wrap the text you want to make bold (alternatively, you can use underscores in place of asterisks).

Your text will look like this:

• This text is bold
• This text is also bold

If you really want to make a point, you can make your text simultaneously bold and italic to give it even more weight! To make your text bold and italic, use three asterisks (or three underscores) to wrap your word or phrase.

Your text will look like this:

• This text is italic and bold.
• This text is also italic and bold

*This text is italic*
_This text is also italic_

**This text is bold**
__This text is also bold__

***This text is italic and bold.***
___This text is also italic and bold___

Links (inline)

• Sometimes we want to link to external websites when writing Markdown content. There’s a simple way to do this using two sets of brackets.
• To format an inline link in Markdown, you use square brackets to wrap your link text. Place the square-bracket wrapped link text alongside parentheses containing your URL (make sure you don’t include a space between the link text and the link).
• Your text will look like this:

  [This is link text](This is a link URL)
  

  If you want to add title to your link, insert your alt text next to the link inside quotation marks Your text will look like this: This is link text

Note that if you want to link to a local file, within the same server as your other Markdown files, you can format your link with a forward slash followed by the relative URL. Your text will look like this: This is link text

Images

• A picture is worth a thousand words, as they say. Inserting an image into your Markdown file is similar to the formatting for links.

• Begin your image formatting with an exclamation mark. Next, use square brackets to wrap your image alt text, next to parentheses containing the URL for your image. Ensure there are no spaces between the exclamation mark, square brackets, or parentheses.

![image](https://user-images.githubusercontent.com/64991656/132938832-0394a87c-fb2d-4d7d-b478-d1b7c474df80.png)

The image will look like this:

When your Markdown file is rendered to HTML, the image will be embedded directly into the body text.

Lists

Unordered lists

• Sometimes, you may want to format your content in lists to make it easier to read.
• The first option is to use an unordered list, where each item on your list is preceded by a bullet point.
• Markdown allows you to format your lists with a number of different symbols: asterisks (*), hyphens (-) or plus signs (+).

It’s up to you to choose which symbol you prefer. The result you get is the same.

- Just add a dash first and then write a text.
- If you add another dash in the following line, you will have another item in the list.
  - If you add four spaces or use a tab key, you will create an indented list.
    - If you need to insert an indented list within an intended one, just press a tab key again.

 Sometimes you want bullet points:

* Start a line with a star
* Profit!

The formatted text will look like this:

• Just add a dash first and then write a text.
• If you add another dash in the following line, you will have another item in the list.
  • If you add four spaces or use a tab key, you will create an indented list.
    • If you need to insert an indented list within an intended one, just press a tab key again.

Sometimes you want bullet points:

• Start a line with a star
• Profit!

Ordered lists

• Other times, you may want to present your information sequentially in ordered lists (1, 2, 3, and so on).
• Format your ordered lists by preceding each list item with a number, followed by a full stop and then a space.
• In Markdown, it doesn’t matter which numbers you use to format your list, as the list will always render as 1, 2, 3, and so on.

1. Just type a number followed by a dot.
2. If you want to add a second item, just type in another number followed by a dot.
1. If you make a mistake when typing numbers, fear not, Markdown will correct it for you.
    1. If you press a tab key or type four spaces, you will get an indented list and the numbering
    will start from scratch.
        1. If you want to insert an indented numbered list within an existing indented numbered one,
        just press the tab key again.
            - If need be, you can also add an indented unordered list within an indented numbered one, an vice versa,
            by pressing a tab key and typing a dash.

The formatted text will look like this:

1. Just type a number followed by a dot.
2. If you want to add a second item, just type in another number followed by a dot.
3. If you make a mistake when typing numbers, fear not, Markdown will correct it for you.
   1. If you press a tab key or type four spaces, you will get an indented list and the numbering will start from scratch.
      1. If you want to insert an indented numbered list within an existing indented numbered one, just press the tab key again.
         • If need be, you can also add an indented unordered list within an indented numbered one, an vice versa, by pressing a tab key and typing a dash.

Blockquotes

Sometimes in Markdown, we will want to reference an external source using quotation marks. This is called a blockquote. You represent any blockquote by preceding the first line of the block quote with a greater-than sign or angle bracket (>). Gruber recommends inserting the angle bracket before every line of your blockquote.

Your text will look like this:

This is a blockquote This is a blockquote This is a blockquote

Horizontal rules

A horizontal rule is a useful little element that you can use to visually split up blocks of text within your Markdown file. A horizontal rule is represented by three or more hyphens (-), asterisks (*), or underscores (_). Whichever symbol you use renders the same output.

Your text will look like this: —

Create a horizontal rule with three or more hyphens, asterisks, or underscores on a line:
---

* * *

___

The formatted text will look like this:

Code blocks and snippets

Code snippets

• Often when we’re writing in Markdown, we need to reference snippets of code as examples. This is particularly common in technical documentation.
• Markdown allows you to format code snippets using backticks ` that wrap your code snippet. The first backtick “opens” the snippet, and the second backtick “closes” it.

`This is a code snippet`

Your text will look like this: This is a code snippet

Code blocks

• Formatting code blocks is useful when you have a bigger chunk of code to include in your Markdown file.

• Format your code blocks by indenting every line of your code block using one tab, or four spaces.

  This is a code block This is a code block This is a code block

There are many different ways to style code with GitHub's markdown. If you have inline code blocks, wrap them in backticks: var example = true.

`var example = true`

If you've got a longer block of code, you can indent with four spaces:

if (isAwesome){
  return true
}

GitHub also supports something called code fencing, which allows for multiple lines without indentation:

if (isAwesome){
  return true
}

And if you'd like to use syntax highlighting, include the language:

if (isAwesome){
  return true
}

Escaping

• Often in Markdown, you will need to include characters in your text (for example, and asterisk) that may be part of the Markdown syntax.
• You need to “escape” these characters so your Markdown application doesn’t read these characters as formatting.
• You escape characters in Markdown using a backslash before the character, with no space in between.

Your text should look like this: *

You can escape any of these characters:

\ backslash
` backtick
* asterisk
_ underscore
{} curly braces
[] square brackets
() parentheses
# hash symbol
+ plus sign
– minus sign (hyphen)
. dot
! exclamation mark

Lists within blockquotes

• Sometimes, you might want to insert a blockquote into your Markdown that contains another element, such as an unordered list.
• You need to nest your list formatting inside your blockquote formatting.
• Format your blockquote using a greater-than sign (>) followed by a space, including a sign before every line of your block quote.
• Add your list formatting (*) just after your greater-than signs.

  > This is a blockquote
  > * This is a list item within a blockquote
  > * This is a list item within a blockquote
  > * This is a list item within a blockquote
  

  Your text should look like this:

  This is a blockquote

  • This is a list item within a blockquote
  • This is a list item within a blockquote
  • This is a list item within a blockquote

HTML

• You can insert HTML elements directly into your Markdown file.
• For example, you may want to include a button. Insert your HTML exactly as you would in any other HTML document.

  <button>This is a button</button>
  

  Your text should look like this:This is a button

-This formatting also works for your other Markdown syntax, such as emphasis. Instead of This element is bold, you could format it in HTML as This element is bold.

Instead of **This element is bold**, you could format it in HTML as <bold>This element is bold</bold>.

Quotes

• Add a quotation with the > character at the beginning of each line: ```markdown

  “I make Jessica Simpson look like a rock scientist.”

—Tara Reid, actress ```

The quote will look like this:

“I make Jessica Simpson look like a rock scientist.”

—Tara Reid, actress

GitHub Flavored Markdown

• GitHub.com uses its own version of the Markdown syntax that provides an additional set of useful features, many of which make it easier to work with content on GitHub.com.
• Note that some features of GitHub Flavored Markdown are only available in the descriptions and comments of Issues and Pull Requests.
• These include @mentions as well as references to SHA-1 hashes, Issues, and Pull Requests.
• Task Lists are also available in Gist comments and in Gist Markdown files.

Syntax highlighting

• Here’s an example of how you can use syntax highlighting with GitHub Flavored Markdown:
• 

function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:'#foo'})
  }
}

• You can also simply indent your code by four spaces:

• 

  function fancyAlert(arg) {

  if(arg) {
    $.facebox({div:'#foo'})
  }
  

  }

• Here’s an example of Python code without syntax highlighting:

• 

def foo(): if not bar: return True

Task Lists

- [x] @mentions, #refs, [links](), **formatting**, and <del>tags</del> supported
- [x] list syntax required (any unordered or ordered list supported)
- [x] this is a complete item
- [ ] this is an incomplete item

• [x] @mentions, #refs, links, formatting, and tags supported
• [x] list syntax required (any unordered or ordered list supported)
• [x] this is a complete item

• [ ] this is an incomplete item

• If you include a task list in the first comment of an Issue, you will get a handy progress indicator in your issue list.

• It also works in Pull Requests!

Tables

• You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |:

  First Header | Second Header
  ------------ | -------------
  Content from cell 1 | Content from cell 2
  Content in the first column | Content in the second column
  

  

Username @mentions

• Typing an @ symbol, followed by a username, will notify that person to come and view the comment.
• This is called an “@mention”, because you’re mentioning the individual.
• You can also @mention teams within an organization.

Automatic linking for URLs

Any URL (like http://www.github.com/) will be automatically converted into a clickable link.

Emoji

GitHub supports emoji!

I am going to write the same article for gfg

A README file is an essential guide that gives other developers a detailed description of your GitHub project. You may be wondering, Why anyone should spend time writing a README file. Well, here are some reasons to help convince you that it's a good idea:

1. A good README helps your project to stand out from other projects. It should be as good as your project itself.
2. It's the first thing to notice while encountering your project, so it should be pretty brief but detailed.

Include Your Project's Title

This is the name of the project. It describes the whole project in few words and helps people understand the primary goal and aim.

Write a Description

Your description is an essential part of your project. A well-maintained description allows you to show off your work to other developers as well as potential employers. The quality of a README description differentiates a good project from bad ones.

1. Inspiration

   What was your motivation? Why did you build this project?

2. What it does

   What problem does the project solve? What your application does?

3. How we built it

   Why you used specific technologies? If your project has a lot of many features, list them here.

4. Challenges we ran into

   Mention some of the challenges you faced and features you hope to implement in the future.

5. Accomplishments that we're proud of

   Mention anything that you think you are proud of building or having in that project

6. What we learned

   What did you know?

7. What's next for Untitled

8. Built With

   Mention languages, frameworks, databases, etc

9. Try it out:

   provide deploy links or any other required links

###How to Use Your Project: Provide instructions and examples so that users or contributors can use the project. This will make it easy for them so that if they encounter a problem, they will always have a place of reference.

Include Credits

If you have worked on the project as a team, list your team members. You should also include their GitHub profiles.

It is interesting, then, to see what language programmers turn to when they have got their pick - when they are coding not with some bosses’ wishes in mind, but when they are just cracking away at a project for the hell of it.

So today, we will discuss three things.

• What mobile platforms show up at hackathons the most?
• Which programming languages are most popular?
• Which APIs do people tap most often?

Okay, for the first part, at a hackathon when it comes to ## mobile app development. The most targeted platform is android, followed by IOs, and very few people target other platforms like windows.

For android apps most popularly used languages are:

• Kotlin and java

However, recently flutter has gained much popularity and using flutter, one can build multi-platform apps using just one language dart. If you are doing an app development project, I highly recommend using flutter.

Moving on to next,

what are the most popular languages used in hackathons

• HTML/CSS (see note below)
• JavaScript
• Python
• Java
• C/C++
• PHP

HTML/CSS and Javascript topping the list seems pretty predictable — they are forgiving, do not require a compiler, run in the browser rather than a specific OS, and tend to be the first languages new coders learn.

Most popular projects are based on web development. It is straightforward and fast to prototype a web-based solution for a problem, And most pros. When doing web development, it is convenient when you are good at javascript as you can make the front-end more interactive or build the entire front-end in javascript in react and even make back-end. Moreover, All of this using only one language. So I highly recommend getting along javascript along with basic HTML and CSS

But what about APIs?

Devpost breaks it down category by category as opposed to lumping them all together under one umbrella, but the champs of each section are all pretty excellent tools to have in your belt.

The most popular communications API according to their data? Twilio.

• Social? Facebook and then Twitter
• Payment? Venmo beats out Paypal, and, perhaps surprisingly, both beat out Stripe.
• Google Maps dominates the geo category, as most would probably assume.
• Twilio’s domination in the communication category makes a ton of sense, if only because Twilio is so active in the hackathon scene.

Wikipedia Definition

A Hackathon is a design sprint-like event; computer programmers and others involved in software development often collaborate intensively on software projects.

Couldn't get it?

In simple words, we can say a hackathon is any event, technical or non-technical, where people work together to devise a solution for a problem.

What happens at a Hackathon?

1. Networking: Hackathons are a great place to network, so take the opportunity to meet new people and make friends during this time.

2. Workshops: Various workshops are conducted by Industry Experts, Community leaders, etc., for beginners.

3. Fun Activities: Apart from Coding and workshops, there are other events where you can have fun!
4. Guess what? If you win, you get swags or gift cards.
5. And, of course, Coding: Lastly, within the time frame, you have to brainstorm various ideas and execute your ideas into code.

What is Hack, and Who is a Hacker?

• Hack: An innovative solution to a real-world problem
• Hacker: The person who develops the solution into code

What can you do as a beginner?

1. Designer - Interested in making graphics? You can play a crucial role in UX designing.
2. Empathizer - Have you experienced the problem that is the focus of the hack? You can help your team build a cool hack.
3. Brain stormer - Think out of the box and build a cool hack
4. Public speaker - Can you present well in front of an audience? If yes, it's your time to shine.
5. Of course, Coding Wiz - Do you love to code? Great, then hackathons are for you.

Where to find hackathons?

1. Devpost
2. Devfolio
3. D2C
4. HackerEarth
5. MLH
6. TechTogether

A hackathon is actually lots of fun, and below are a few reasons why any budding developer should go to a hackathon:

1. Meet People and build connections: Hackathons provide you an excellent opportunity to meet new people. Start connecting with others, ask them about their interests, and have an idea for a project to build. Hackathons are a great head start for college freshers since students get opportunities to meet, collaborate, and work with others and get a chance to build essential connections.
2. Learn New Technologies in a short duration: Participants get an opportunity to learn about trending technologies like blockchain, game-fi, google cloud, AR/VR, etc. Throughout the weekend, you will learn many things, taking from technical skills to soft skills. Be open to all opportunities and tasks. You will get to do something you have never done before; you have to do something faster than you are used to, since the limited amount of time given pressures you.
3. Builds your CV: Participants can include their hackathon project in their CV for greater visibility among recruiters, which will help them have a technical topic of discussion in their interviews.
4. You'll get to pair-program: Pair programming is an agile software development technique in which two programmers work together at one workstation. Pair-programming is excellent if you want to focus more and would enjoy discussing problems with a partner.
5. You'll learn and build something by the end of the weekend and will automatically contribute to open source.
6. You'll get lots of swags.
7. You'll grow as a developer: You'll learn from other people, from being forced to understand better the unfamiliar framework your team picked to use, and from being able to sit by your team and ask or answer any immediate questions.
8. Work Under Pressure: Hackathon is a real test of your time management skills and ability to work with a team. Teamwork is the key to success, and accepting and working on other people's opinions is crucial.
9. Enhance your creativity: Hackathon is about originality, so bring your craziest ideas. Be creative and original, think out-of-the-box, and show the awesome stuff you are capable of thinking.
10. You will get a skill-enhancing break from your regular schedule!

Hackathon Judges – What Do They Evaluate?

The evaluation criteria vary from one hackathon to another, but there are some common patterns:

1. Idea's originality– hard things that haven't been done before.
2. Visual aspects of the project: UX/UI are well-crafted and beautiful interfaces that will help your team better explain the idea.
3. Solid technical solutions: Technical complexity (how much learning the team did during the weekend)
4. Are judges at hackathons focused on a specific theme? If there are themes involved, you need to make sure to tie your app into one of the themes.

As you can see, it's hard to know the judging criteria. Therefore, invest your time building a project that you feel proud of. It's great to align your vision with the hackathon topic and context, but do not overthink while creating the project you think judges want. Play freely and create something you are passionate about.

The perfect pitching structure

• Focus first on demoing your project. You need to keep it realistic.
• Keep slides to a minimum: If you use slides, use them to tell a story, add some humor, introduce persons who will use your app, or describe the architecture from a high level.
• Don't let a lousy pitch ruin your chances of winning your next hackathon. And always remember, the most essential part of any hackathon is the 2-3 minutes of you and your team's pitch.

Here is an excellent structure to make your pitch:

Intro (presented in 15 seconds): Start the video with a brief introduction to your project (team name, project name) but don't introduce each member; you can eat up a lot of time. Problem statement (presented in 15 seconds): What problem did you identify for solving? How big is the problem? Impact (presented in 15 seconds): How could solving the problem add to the market? Product (presented in 1 minute):

1. What was the inspiration for the idea?
2. What is the app?
3. Who are your target users?
4. What are the core features?
5. What makes your app different?
6. What would you have focused on if you had more time?
7. What's the business value of this app?
8. What is your plan for the idea post hackathon?

Demo (presented in 1 minute): One minute to demonstrate and explain the hack. Core features of the app. Actually, demo your project. The judges need to see the working project, in addition to hearing what you did.

Wrap up (presented in 15 seconds): Be sure to mention what was used to build core features – Highlight all technologies used in your app, especially sponsor technology.

Project Demo Tips

1. Know the Rules: Every hackathon has different rules that will impact how you should structure your pitch.
2. The Demo Video must be three minutes or less in length. That's approximately 400 words and 27 sentences. Make every second count!
3. Always write a script on what you want to say and show, and practice it over and over again.

4. In a hackathon, you start making a concept of your product and then code it. Do the same with the pitch, get the storyline straight first and then build it. Bring the audience straight into the story.

5. What's the problem you're solving?

6. How big is the problem?
7. What does it cause?
8. How much detail? I have seen many technical pitches, which got utterly lost in the details of the technology. Don't disappear in the details! Keep to the headlines and ensure that you have time to cover all the topics, not just the specific product.
9. The Demo Video must be uploaded to an accessible site (e.g., YouTube, Dropbox, Drive, etc.) A working public link to the demo video must be created, and it should be playable from the web with the site's built-in player.
10. Make sure it provides a clear sound.
11. You do not need everyone to present on the Video. Select 1 person from the team to deliver the presentation.
12. Have a planned time to make your demo video, and don't wait till the last minute of the hackathon. Give yourself and your team time to make a nice video. If you want to do any editing on it, make sure you have enough time for that as well.
13. Landscape videos typically look better when viewed, so record in landscape mode, with your phone, held horizontally.
14. The Video's focus should be on pitching your project and not about the making of your project.
15. Review the Video; editing is Optional: Unless it's one of the event requirements, editing the Video is NOT required. But you should review the tape to ensure it says all the points you want others to know about your project and highlights what makes it unique.
16. Now, you just need to upload the video, get the link, and send it to someone else to verify if it plays to the end.

Post Hackathon Tips

You've worked tirelessly through the days and nights, built something extraordinary, and presented it to a panel of judges. It could also be that you gave it your best try but didn't make it up to your expectations. Either way, you left the hackathon with maybe a prize or two, a few new technical knowledge, new friends, and swags. But what's next? You could choose to continue working on the project, complete it if necessary, or add that cool features you didn't have the time to implement in the hackathon. On the other hand, you could forget about it, remembering it for fun and learning.

Wrap-up Session

The wrap-up session with your teammates to report what they accomplished or what they learned. If you won, then have a party (maybe virtual) and enjoy! If you have lost, talk to each other. What could have been better?

Before that:

Thank the mentors and organizers from whom you have taken help or guidance. If there was any feedback form or address form, fill it. If you got any credits, redeem them. If there is a post-event, attend it.

After the event:

Teammates should come together to talk about the event's success and hear each other out. Use feedback and new ideas (maybe the judges had great suggestions you hadn't thought about)

• What worked well?
• What could have been done better?
• Where does everyone see this idea heading?
• What're the other things everyone wished were implemented during the hackathon?
• What are the new ideas that came to mind since the event?
• Write down everything that went right, so you can repeat it next time.
• Write down everything that went wrong so you can avoid it next time.
• Write a note in your diary about the event.

A README.md

It's the most essential part of your project and perhaps even more critical than any landing page. Use it to tell everyone about your idea, the technologies that make it happen. This is the most straightforward addition with the most significant impact. No matter how cool your hack is or how well you know your own code, make it concise and detailed for everyone. What might you include?

A picture tells a thousand words, So capture everyone's attention with a banner or screenshot of the homepage.

• A logo is an excellent addition if you are hosting the code in a personal repo.
• Project name
• Description of the project to sum up the solution in one or two sentences.
• Implemented libraries or technologies in your project.
• A link to your deployed project.
• If you won any prizes for your project, mention them as well.
• Inspiration
• What it does
• How you built it
• Challenges you ran into
• Accomplishments that you're proud of
• What you learned
• What's next for your project
• Attach a team photo!

Pro Tip: Add as LinkedIn Project Go to your LinkedIn profile, Go to the project section and add the GitHub URL, the project's name, and a short description.

The Bare Minimum Maintainance

After the hack, you are probably stuck with a messy codebase on GitHub. While in most hackathons, the cleanliness of your code is not judged, you probably want to do your portfolio a favor Spend some time looking over the code as a whole and remove unwanted whitespace and fix any confusing variable names. Provide a few comments for others to understand.

Have FUN!

Feel proud of yourself, and don't take anything too seriously. You've got this! All the best for your next hackathon!