15a68a55d9
Introduces `repositories.txt` to define external VPM repositories required by the project. Updates the README with guidance for ALCOM users on importing these repositories and the importance of exporting the file before pushing changes to ensure proper dependency management.
57 lines
1.3 KiB
Markdown
57 lines
1.3 KiB
Markdown
## How to clean the Packages folder even after a previous commit
|
|
> git rm -r --cached Packages/
|
|
|
|
|
|
## ALWAYS TRACK THESE FILES (never ignore them)
|
|
- Packages/manifest.json
|
|
- Packages/vpm-manifest.json
|
|
- ProjectSettings/
|
|
- Assets/
|
|
|
|
|
|
## How to configure LFS in your repository
|
|
|
|
First, install Git LFS on your machine.
|
|
|
|
```bash
|
|
brew install git-lfs
|
|
```
|
|
|
|
Enable LFS for your repository.
|
|
|
|
```bash
|
|
git lfs install
|
|
```
|
|
|
|
Add the files you want to track with LFS.
|
|
|
|
```bash
|
|
git lfs track "*.png"
|
|
git lfs track "*.jpg"
|
|
git lfs track "*.psd"
|
|
git lfs track "*.fbx"
|
|
git lfs track "*.obj"
|
|
git lfs track "*.wav"
|
|
git lfs track "*.mp3"
|
|
git lfs track "*.ogg"
|
|
git lfs track "*.anim"
|
|
git lfs track "*.controller"
|
|
git lfs track "*.mat"
|
|
git lfs track "*.prefab"
|
|
git lfs track "*.unity"
|
|
git lfs track "*.asset"
|
|
git lfs track "*.unitypackage"
|
|
```
|
|
|
|
Then, configure LFS for your repository.
|
|
|
|
```bash
|
|
git config lfs.https://git.example.org/user/repo.git/info/lfs.locksverify true
|
|
```
|
|
|
|
## (ALCOM only) Export the repositories text file
|
|
When you git clone this repo, it won't include any packages required by the manifest.
|
|
This is by design, so we need to install them via ALCOM, but we first need to import any necessary repositories.
|
|
|
|
So its **highly recommended** to export the repositories text file before pushing any changes.
|