Selaa lähdekoodia

Update readme to only use repo clone method

Signed-off-by: guillaume-haerinck <[email protected]>
guillaume-haerinck 1 vuosi sitten
vanhempi
commit
f2631ed4fa
1 muutettua tiedostoa jossa 5 lisäystä ja 3 poistoa
  1. 5 3
      README.md

+ 5 - 3
README.md

@@ -10,16 +10,18 @@ The player takes the role of a newspaper delivery kid who, within a vast fiction
 
 
 You need to build or [install O3DE engine](https://o3de.org/download/).
 You need to build or [install O3DE engine](https://o3de.org/download/).
 
 
+You need to [install git with lfs support](https://git-scm.com/downloads), and [setup a token on your github account](https://www.docs.o3de.org/docs/welcome-guide/setup/setup-from-github/#configure-credentials-for-git-lfs). Needed as the repository uses Git LFS, the "Download ZIP" button will not download assets.
+
 ## How to run
 ## How to run
 
 
-1. Download (green "Code" button, then "Download ZIP") or clone the github repository (`git clone https://github.com/o3de/NewspaperDeliveryGame.git`)
+1. Clone the github repository (`git clone https://github.com/o3de/NewspaperDeliveryGame.git`). When prompted to authenticate, use your github username and the token as password.
 2. Launch O3DE. It will open the Project manager. Click on the **New Project** button then **Open Existing Project** option.
 2. Launch O3DE. It will open the Project manager. Click on the **New Project** button then **Open Existing Project** option.
-3. Navigate to your download (and make sure it is unzipped). Open the folder. The project should now be registered.
+3. Navigate to the cloned repository. Open the folder. The project should now be registered.
 
 
 ![project](Media/project.png?raw=true)
 ![project](Media/project.png?raw=true)
 
 
 4. Click on the **Build Project** button, located on the **Newspaper_Delivery_Game** image.
 4. Click on the **Build Project** button, located on the **Newspaper_Delivery_Game** image.
-5. Once the project has been built sucessfully, use the **Open Editor** button.
+5. Once the project has been built successfully, use the **Open Editor** button.
 6. The asset pre-processor will run for a bit. Once it is over you will be welcomed with the **Open a Level** window. Pick the **Neighborhood**.
 6. The asset pre-processor will run for a bit. Once it is over you will be welcomed with the **Open a Level** window. Pick the **Neighborhood**.
 
 
 ## Controls
 ## Controls