Submitting

Requirements

Before submitting, make sure your GitHub repository includes the following:

• A Journal.md file in the root folder (if you are not using lapse)
• The source file for your project. In this case, it is a Circuit.txt from Falstad. You can download this by going to File -> Save As
• A detailed README.md

What should my README include?

Your README.md should include the following:

• A short description of what your project is
• A demo video or GIF of your circuit and a link to a live demo (falstad link)
• A brief description of how it works

To get a demo link from Falstad, go to File -> Export As Link.

Please please please format your README nicely, make sure of markdown!

Don't:

• Have everything just be plain text
• Long links pasted as text
• Have broken embeddeds
• Leave it empty (duh)

Do:

• Use markdown formatting for headings, links, images and etc! (markdown is easy and fun)
• Use clear structure
• Explain the purpose of the project

---

An example of a good repository would be: github.com/Outdatedcandy92/555-Blinky It's got the falstad source file and an informative readme which includes a demo video and a project link.

Once you have everything ready you can go ahead and submit your project by using this form .