From b4984763b45d30b3005d0c07eb25d909da00e0bb Mon Sep 17 00:00:00 2001
From: raccoon <raccoon@home.net>
Date: Thu, 6 Feb 2025 18:22:00 +0500
Subject: [PATCH] Added steps for existing project

---
 README.md            | 20 ++++++++++++++++++--
 vpm-repositories.txt |  5 +++++
 2 files changed, 23 insertions(+), 2 deletions(-)
 create mode 100644 vpm-repositories.txt

diff --git a/README.md b/README.md
index 5d421d6..d68ff03 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,11 @@
 # VRChat Unity project template
+
 Omni-template for making VRChat content
 
 ## Synopsis
+
 The template have:
+
 - Unity Editor settings for work with Git
 - Git settings for work with Unity Editor
 - Git LFS attributes
@@ -14,7 +17,8 @@ The template have:
 
 The repository have separate branches for separate content types, the only difference between them is default packages in `Packages/vpm-manifest.json`
 > Branches structure
-> ```
+>
+> ```text
 > -master-+---------------------->
 >         |\
 >         | \-world-------------->
@@ -22,7 +26,8 @@ The repository have separate branches for separate content types, the only diffe
 >           \-avatar------------->
 > ```
 
-## How to use
+## How to use for a new project
+
 1. `git init` a new repo from the branch you want
 2. Init Git LFS with `git lfs install`
 3. Open the project in Unity
@@ -31,10 +36,21 @@ The repository have separate branches for separate content types, the only diffe
 
 > After opening the project in Unity Editor you might want to add **all** new files to Git.
 
+## How to work with existing project
+
+1. Check that you have git-lfs installed `git lfs status`
+2. Pull existing repo `git pull https://gitlab.com/ProcyonLotor/vrchat-template.git` and optionally pull all LFS objects `git lfs fetch --all`
+(repo will take much more disk space, but will have complete project history)
+3. (Optional) Some VPM packages might come from Community Repositories,
+add them from project's [vpm-repositories.txt](./vpm-repositories.txt) file to CreatorCompanion,
+or run this command in project's folder `FOR /F %L IN (.\vpm-repositories.txt) DO vpm add repo %L`
+(command requires `vpm` tool installed, see [vpm cli](https://vcc.docs.vrchat.com/vpm/cli/))
+
 > **IMPORTANT**: When opening a previously worked on project on a new machine, Unity may warn you about script errors and suggest you enter Safe Mode,
 > this is because VPM has not loaded yet and didn't resolved the required packages, ignore the errors and continue loading.
 > Sometimes you may need to reopen the project couple times for all packages to resolve and scripts to recompile.
 
 ## License
+
 For project's license see [LICENSE](./LICENSE) file.
 Project contains `com.vrchat.core.bootstrap` package, for license see [Packages/com.vrchat.core.bootstrap/License.md](./Packages/com.vrchat.core.bootstrap/License.md) file.
diff --git a/vpm-repositories.txt b/vpm-repositories.txt
new file mode 100644
index 0000000..a342180
--- /dev/null
+++ b/vpm-repositories.txt
@@ -0,0 +1,5 @@
+https://adjerry91.github.io/VRCFaceTracking-Templates/index.json
+https://poiyomi.github.io/vpm/index.json
+https://vcc.vrcfury.com/
+https://spokeek.github.io/goloco/index.json
+https://wholesomevr.github.io/SPS-Configurator/index.json