ink-inc / MagicMittelalterGame

An awesome game for awesome people
3 stars 1 forks source link

Clone a repository

Use these steps to clone from Github. Cloning allows you to work on your files locally. This projekt uses large files meaning you need to install git lfs.

  1. You’ll see the clone button under the Clone or download heading. Click that button.
  2. Copy the link.
  3. Open your Comand Line Tool of your choice.
  4. Navigate to the destination folder.
  5. Enter git clone <copied link>.

If you installed git lfs after cloning the project git lfs fetch can work, but in most cases you have to delete the local project and re-clone it again.

Adding large files

Large files should be tracked by lfs. This can be done with

git-lfs track <file>

You could use all sorts of regrex expressions here. For example

git-lfs track Assets/Sounds/**  # tracks everything in the sound directory
git-lfs track '*.bin'           # tracks every bin file

LFS track after check-in

If you already commit large files and forgot to track them. No worries! This simple trick should do it. This is an example for the directory Sounds in Assets but it should work with all other regrex expressions.

Subfolders must be tracked separately!

git rm -r --cached Assets/Sounds/**
git-lfs track Assets/Sounds/**
git add Assets/Sounds/
git commit

Verfiy they are tracked with: git-lfs ls-files.

Github Pages

We use Github Pages to track important notes and documentation for programming: Documentation