Question

I`m planning a project, and was wondering if it would be a good idea to use GitHub as a code repository for the project.

The project is just me creating a single application step by step. In fact, it is more like me learning how to do it, and documenting my process, and letting other people tag along.

So step 1 could be setting up the project, step 2 how to organize the files, step 2 connecting to the database, step 3 how to do the UI etc. (btw. this is not how the project is set up)

The documentation would consist of a website with articles for each step and along with each step I want to enable the visitor to download/view the code for the project to the point where we are in the process.

I don`t know how top use GitHub, but I was planning on learning it as well. Would GitHub be a good way to share the code for a project like this?

Is there a way in GitHub to take snapshots, like step 1, step 2, etc., or would it be better to use branches or forks for this?

A nice feature would be the ability to correct the entire chain of steps if I find a typo in step one.

Does anyone know of an existing GitHub project that is set up in a similar way?

Answer 1

You could use GitHub, provided you push also tags for each significant steps.
(as explained in “How do I use github tags to create downloads for my project?“)

That way, you can provide download links for each of those tags, even for the readers who don’t have Git installed.

See “All of your downloads. One big button.“