Processes, procedures, and reference
Loading...
Searching...
No Matches
The Github Template

We use a github template to start Unreal and Unity VR Projects: https://github.com/PixoVR/pixo-production-template

This template contains .gitignore, .gitattributes, README.md and LICENSE.md, which should be compatible with any version of Unreal and Unity.

Note that both .gitignore and .gitattributes use globbing syntax to make paths and filetypes as case-agnostic as needed, at the expense of readability of the file.

For instance:

*.[Aa][Bb][c-e]

matches:

*.ABc *.ABd *.ABe *.Abc *.Abd *.Abe *.aBc *.aBd *.aBe *.abc *.abd *.abe

.gitignore

This contains just about every conceivable artifact that we have encountered, but new use cases appear at times. Let us know if you find something we missed!

.gitattributes

These entries are necessary to make LFS work correctly. Please note that even though .gitattributes is usually applied at the root of a repository, it can also be created in subfolders if, for instance, you want to not commit a file to LFS because you want it to natively be present in a cloud build, or you expect it to never change, or you don't want it to exist as a raw file in the .git folder, or any other reason.

README.md

This readme is a basic template, which has a \todo item in it asking the creator to update it. The setup_submodule.sh script found in docs-doxygen will softlink this file into the pages/ folder when documentation is created for a repository. This file should be updated by a repository owner to include any details important to a first time user of the repository.

LICENSE.md

This is the standard Gnu General Public License, which is adequate for our uses today. This may be changed in the future or changed on individual repositories, but for now it is a useful starting place.