From 9939b1fe19c172d289f08237d80ff69d931b6717 Mon Sep 17 00:00:00 2001 From: Eliot Partridge Date: Fri, 30 Aug 2019 20:57:33 -0500 Subject: [PATCH] Notes on git LFS and where to npm install (#45) --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 02ccfb2..d96e461 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,16 @@ A game of ponies building a town * [gulp](http://gulpjs.com/) `npm install -g gulp` * MongoDB: [download link](https://www.mongodb.com/download-center/community) and [installation instructions](https://docs.mongodb.com/manual/administration/install-community/) * [ImageMagick](https://imagemagick.org/script/download.php#windows) (optional, required for generating preview gifs in animation tool) +* [Git LFS](https://git-lfs.github.com/) + +## Before you clone + +**Ensure you have Git LFS installed before you clone the repo!** Git LFS is required to pull down the asset files the game uses, as storing them in normal Git would stuff up the tree pretty badly. ## Installation +Once you have the project cloned, open your terminal of choice (Command Prompt, bash, etc), navigate to the directory you cloned the project in, and run: + ```bash npm install ```