Save Your Projects With GitHub & Documentation | Zero To Maker Workshop

🔗 *The full guide* : _https://core-electronics.com.au/courses/zero-to-maker-workshop/_

Earn some cred within the Maker community and keep track of your project progress. Documenting and backing up projects are essential when working on and completing your projects!

In this chapter, we'll explore Git, and GitHub a method of backing up and adding a timeline to the code of your project. We'll learn how to set up a repository (repo) to store all of the files in your project, commit our code to the cloud, and make a checkpoint we can refer back to later if anything goes wrong. GitHub also allows other Makers to use, test, and remix your code - an essential aspect of the Open Source community.

Then let's share all of our hard work! We can use the same repo to set up a free website to show off our project. GitHub Pages lets us use Markdown - a simple human-readable markup language (letting us spend time on the fun stuff). We'll add a photo and a couple of pages to demonstrate the power of this sweet website-building tool.

To follow along with our projects, you can see our project websites here:

https://fabacademy.org/2024/labs/lakemac/students/liam-howell/

https://fabacademy.org/2024/labs/lakemac/students/jaryd-giesen/

For more documentation on Git & GitHub:

https://core-electronics.com.au/guides/maintaining-a-project-with-git/

https://docs.github.com/en/get-started

https://docs.github.com/en/desktop/overview/getting-started-with-github-desktop

For more documentation on GitHub Pages:

https://docs.github.com/en/pages/quickstart

https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax

https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll

💡❓ If you have any questions about this content or want to share a project you're working on head over to our *maker forum:* _http://coreelec.io/forum_

0:00 Intro
0:30 Setting up GitHub Desktop
2:09 Creating and Cloning a Repository
3:40 Committing and Pushing
5:14 Pulling from Repository
7:20 Documenting Your Projects
8:07 Making a Documentation Site with Github Pages
9:05 Creating a Page with Markdown
12:54 Creating a Link
15:05 Adding an Image


🌏🦘 *Core Electronics* is located in the heart of Newcastle, Australia. We're powered by makers, for makers. Drop by if you are looking for:

• *Raspberry Pi* _https://core-electronics.com.au/raspberry-pi.html_
• *Arduino* _https://core-electronics.com.au/arduino.html_
• *Sparkfun* _https://core-electronics.com.au/brands/sparkfun-australia_
• *Adafruit* _https://core-electronics.com.au/brands/adafruit-australia_
• *Pololu* _https://core-electronics.com.au/brands/pololu-australia_
• *DFRobot* _https://core-electronics.com.au/brands/dfrobot-australia_

The following trademarks are owned by *Core Electronics Pty Ltd:*

"Core Electronics" and the Core Electronics logo
"Makerverse" and the Makerverse logo
"PiicoDev" and the PiicoDev logo
"GlowBit" and the GlowBit logo