Skip to content

Commit 32ab618

Browse files
committed
updated README and gave the update script saner defaults
1 parent f889240 commit 32ab618

File tree

2 files changed

+24
-8
lines changed

2 files changed

+24
-8
lines changed

README.md

+18-3
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,17 @@ If you want to use Kod, simply download the latest "stable" version from [http:/
1515

1616
## Development
1717

18-
**Get the source:**
18+
**Get the source (for building):**
1919

2020
git clone --recursive https://github.com/rsms/kod.git
21+
git remote add upstream https://github.com/rsms/kod.git
22+
23+
**Get the source (for contributing):**
24+
25+
If you want to contribute to the project you will have to [http://help.github.com/forking/](make a fork). Then do this:
26+
27+
git clone --recursive [email protected]:MyUsername/kod.git
28+
git remote add upstream https://github.com/rsms/kod.git
2129

2230
**Build dependencies:**
2331

@@ -45,10 +53,17 @@ Via Homebrew:
4553

4654
### Refreshing your clone
4755

48-
Since Kod is made up of a main repository as well as a few sub-repositories (git submodules) a simple `git pull` is not sufficient to update your source tree clone. Use the `pull.sh` shell script for this:
56+
Since Kod is made up of a main repository as well as a few sub-repositories (git submodules) a simple `git pull` is not sufficient to update your source tree clone. Use the `update.sh` shell script for this:
57+
58+
./update.sh
59+
60+
It will fetch updates from the upstream repository (rsms/kod). Then you should merge the branches you want to use, for example something like so:
61+
62+
git merge upstream/master
4963

50-
./pull.sh
64+
You can use it to update from your own repository by calling it like this:
5165

66+
./update.sh origin
5267

5368
### Contributing
5469

pull.sh update.sh

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
#!/bin/sh
22

3-
if [[ $1 && $1 == upstream ]]; then
4-
echo "Fetching from upstream (https://github.com/rsms/kod.git)..."
5-
git fetch https://github.com/rsms/kod.git
6-
else
3+
if [[ $1 && $1 == origin ]]; then
74
echo "Fetching from origin..."
8-
git fetch origin
5+
git fetch origin
6+
7+
else
8+
echo "Fetching from upstream (https://github.com/rsms/kod.git)..."
9+
git fetch upstream
910
fi
1011

1112
echo "Updating submodules..."

0 commit comments

Comments
 (0)