Work on README

This commit is contained in:
Alan O'Cull 2023-09-25 13:19:15 -04:00
parent 9de1b0b86f
commit d8f8bc148d
2 changed files with 21 additions and 0 deletions

4
guides/git_setup.md Normal file
View File

@ -0,0 +1,4 @@
# Setting up Git
Git comes pre-installed on Linux systems, but not Windows. Thus, you'll have to install it manually.
It comes in a couple flavors, my favorite being the terminal, but we'll stick to UI for now so it's easier to tell what's going on.

View File

@ -1,3 +1,20 @@
# Git Gud # Git Gud
Tutorial for setting up and using version-control software. Tutorial for setting up and using version-control software.
## What is Git?
Git is a version-control tool used to track files and sync them across computers.
Git is handy because it keeps backups of project files over time, both on the cloud and on your system.
If you make breaking changes but don't realize until after you did some other stuff, you can simply revert only the breaking changes, while leaving other things unaffected.
If your hard-drive crashses and you lose all your files, they're still backed up on the server. Even if the server *also* crashes, anyone else working on the project will still have the entire project history stored on their machine, which can then be pushed to a different Git server to continue collaboration.
Note that ***these benefits only apply if you're properly utilizing Git***, hence this tutorial.
Git is primarily used to allow for code-collaboration between peers.
This means it works with text files, and can track changes to individual lines of text, allowing users to see what changed across periods of time.
However, Git can be extended to work with larger, binary-format files like images, meshes, and other things. Enter Git LFS (Large File System).
We'll be using this system to store larger files on the cloud, like Blender files, textures, and Unreal Blueprints.
## Guides
- [Setting up Git](guides/git_setup.md)
- [Setting up Repositories](guides/setting_up_repository.md)
- [Synchronizing Changes](guides/commit.md)