common/README.md
mark 4c929d61c7 Update README.md
Signed-off-by: mark <mark@joshwel.co>
2024-08-18 16:13:33 +00:00

1.5 KiB

git lfs files

quickstart script

  1. make a folder or navigate to a folder where you want the repo to be in

  2. right click on the folder and open PowerShell or Open in Terminal

  3. run the following:

    irm "https://forge.joshwel.co/mark/common/raw/branch/main/repoquickset.ps1" | iex
    

file placements

  • for Game-only projects

    Game (Unity) Repository Folder
    ├── .git/
    ├── .gitignore      (from Unity.gitignore)
    ├── .gitattributes  (from Unity.gitattributes)
    └── ...
    
  • for Modelling-only projects

    Modelling (Maya / Z Brush / Substance Painter) Repository Folder
    ├── .git/
    ├── .gitattributes  (from Modelling.gitattributes)
    └── ...
    
  • for Shared projects

    Shared Repository (a la Integrated Project)
    ├── .git/
    ├── Game
    │   ├── .gitignore        (from Unity.gitignore)
    │   ├── .gitattributes    (from Unity.gitattributes)
    │   └── ...
    ├── Modelling
    │   ├── .gitattributes    (from Modelling.gitattributes)
    │   └── ...
    └── ...
    

setting up lfs

# init git lfs
git lfs install

# optional, for multi-user/multi-collaborator repositories
git config lfs.https://forge.joshwel.co/<username>/<repository>.git/info/lfs.locksverify true

also see the forge's Resources page for more info on setting up LFS projects