diff --git a/.gitignore b/.gitignore index c89e4ae23..4a330d62c 100644 --- a/.gitignore +++ b/.gitignore @@ -93,6 +93,5 @@ $RECYCLE.BIN/ /mk/linux/zetaglest /mk/linux/zetaglest_editor /mk/linux/zetaglest_g3dviewer -data source/masterserver mk/linux/tools-for-standalone-client/installer/mojosetup diff --git a/BUILD.md b/BUILD.md index 9055c3f78..1c5249f98 100644 --- a/BUILD.md +++ b/BUILD.md @@ -10,9 +10,16 @@ If you would like to contribute to development, you will need to ### Procedure for cloning your forks -1. Create a new directory to clone your **zetaglest-source** and **zetaglest-data** into e.g. call it `zetaglest`. -2. Enter (or 'cd') into the new directory (`zetaglest` in the example). -3. clone **zetaglest-source** and **zetaglest-data** using the clone info provided by your fork. (Use "Clone or Download" link, but **do** select `clone` **not** `Download Zip`.) Make sure the cloned repo directories are in the same directory, adjacent to each other (and **not** in a subdirectory). +1. Create a new directory to clone your **zetaglest-source** and +**zetaglest-data** into e.g. call it `ZetaGlest`. + +2. Enter (or 'cd') into the new directory (`ZetaGlest` in the example). + +3. clone **zetaglest-source** and **zetaglest-data** using the clone +info provided by your fork. (Use the "Clone or Download" link, but +**do** select `clone` **not** `Download Zip`.) Make sure the cloned +repo directories are in the same directory, adjacent to each other (and +**not** in a subdirectory). ### Note diff --git a/README.md b/README.md index 6029c1a0d..be6adc107 100644 --- a/README.md +++ b/README.md @@ -47,15 +47,15 @@ See [Build instructions](https://github.com/ZetaGlest/zetaglest-source/blob/deve ### Try the game without contributing -Use this command: +Use these commands: - git clone https://github.com/ZetaGlest/zetaglest-source.git zetaglest - cd zetaglest - git clone https://github.com/ZetaGlest/zetaglest-data.git data + mkdir ZetaGlest + git clone https://github.com/ZetaGlest/zetaglest-source.git + git clone https://github.com/ZetaGlest/zetaglest-data.git Afterward, to [build](https://github.com/ZetaGlest/zetaglest-source/blob/develop/BUILD.md), -change to the mk/ directory, select your operating system and run +change to the zetaglest-source/mk/ directory, select your operating system and run ./build-zg.sh diff --git a/git_update.sh b/git_update.sh index 9c26f22e3..ce4cbffcc 100755 --- a/git_update.sh +++ b/git_update.sh @@ -1,13 +1,24 @@ #!/bin/bash +# +# git_update.sh: update the ZetaGlest source and data repos. Use this +# script if you've cloned from the master repositories, not if you're +# a fork. +# +# FIXME: there should be a way to check if this is a clone of the +# main repo, or a fork. If it's a fork, this shouldn't be run. Mentioned +# in the docs, but it would be good to have a catch in this script. + export LANG=C cd "$(dirname $(readlink -f $0))" && -echo $PWD && +echo $PWD git pull && -cd data && +echo $PWD + +cd ../zetaglest-data && git pull && exit 0