Template:Obtaining The Source Code: Difference between revisions
Auswaschbar (talk | contribs) No edit summary |
|||
| (60 intermediate revisions by 10 users not shown) | |||
| Line 1: | Line 1: | ||
=== | === Tarballs === | ||
'''(For playing | '''(For playing online official games on lobby.springrts.com - the spring lobby server)''' | ||
{{Tarballs}} | |||
=== Git === | |||
[https://github.com/spring/spring Spring project page at github] | |||
Master repo URI: <code>{{GitCloneUrl}}</code><br/> | |||
Backup repo: <code>git://git.code.sf.net/p/springrts/code</code> | |||
Branches of interest: | |||
* master - latest stable, enforced for official games on lobby.springrts.com | |||
* maintenance - fixes for the latest stable | |||
* develop - major developments (most active, larger developments) | |||
Assuming the GIT command line client is installed, you can clone (get locally) the repository with the commands below. | |||
====Latest Stable (master branch, useless for development purposes, lives as maintenance moving forward)==== | |||
<pre>git clone --recursive git://github.com/spring/spring.git -b master</pre> | |||
To later update it (get the changes other people did) with: | |||
<pre>git pull --rebase</pre> | |||
=== | ====Maintenance (maintenance branch)==== | ||
<pre>git clone --recursive git://github.com/spring/spring.git -b maintenance</pre> | |||
====Bleeding-edge (develop branch)==== | |||
<pre>git clone --recursive git://github.com/spring/spring.git -b develop</pre> | |||
====Working with git==== | |||
Please note that patches to the code must be done for either develop or maintenance. Such patches can be then sent to one of the developers with repository access. If you are new to git and github, you may want to have a look at [http://help.github.com/ this guide] to get you started. | |||
Note: you can switch <code>branches</code> this way:{{code| | |||
# (optional) backup your current code changes | |||
git stash | |||
# switch branch | |||
git checkout $MY_OTHER_BRANCH | |||
# sometimes needed | |||
# note, it deletes all your unstashed changes and all non-pushed commits on the new branch, | |||
# but it doesn't delete untracked files. | |||
#git reset --hard | |||
# update/sync with remote repo | |||
git pull --rebase | |||
# (optional) if you want to apply the code changes backed-up in the first step | |||
#git stash pop # reapplies your changes and DELETES the backup | |||
# or | |||
#git stash apply --index 0 # reapplies your changes and keep the backup (see `git stash list`) | |||
}} | |||
If | ====Submodules==== | ||
To obtain the submodules you should clone the repository with --recursive as mentioned above. | |||
If you haven't done this, you can execute the following code | |||
{{code| | |||
git submodule sync | |||
git submodule update --init | |||
}} | |||
To update the submodules, you have to execute the same commands again or pull normally. | |||
Latest revision as of 17:24, 6 May 2020
Tarballs
(For playing online official games on lobby.springrts.com - the spring lobby server)
Using Git is the recommended way to get the sources of the engine.
In spite of, you can use the official tarballs to compile Spring without git.
Note: Do NOT use the zip-files from github, they are missing important data to compile Spring.
See Building spring for build instructions.
Git
Master repo URI:
git://github.com/spring/spring.git
Backup repo: git://git.code.sf.net/p/springrts/code
Branches of interest:
- master - latest stable, enforced for official games on lobby.springrts.com
- maintenance - fixes for the latest stable
- develop - major developments (most active, larger developments)
Assuming the GIT command line client is installed, you can clone (get locally) the repository with the commands below.
Latest Stable (master branch, useless for development purposes, lives as maintenance moving forward)
git clone --recursive git://github.com/spring/spring.git -b master
To later update it (get the changes other people did) with:
git pull --rebase
Maintenance (maintenance branch)
git clone --recursive git://github.com/spring/spring.git -b maintenance
Bleeding-edge (develop branch)
git clone --recursive git://github.com/spring/spring.git -b develop
Working with git
Please note that patches to the code must be done for either develop or maintenance. Such patches can be then sent to one of the developers with repository access. If you are new to git and github, you may want to have a look at this guide to get you started.
Note: you can switch branches this way:<syntaxhighlight lang="bash">
- (optional) backup your current code changes
git stash
- switch branch
git checkout $MY_OTHER_BRANCH
- sometimes needed
- note, it deletes all your unstashed changes and all non-pushed commits on the new branch,
- but it doesn't delete untracked files.
- git reset --hard
- update/sync with remote repo
git pull --rebase
- (optional) if you want to apply the code changes backed-up in the first step
- git stash pop # reapplies your changes and DELETES the backup
- or
- git stash apply --index 0 # reapplies your changes and keep the backup (see `git stash list`)
</syntaxhighlight>
Submodules
To obtain the submodules you should clone the repository with --recursive as mentioned above. If you haven't done this, you can execute the following code <syntaxhighlight lang="bash"> git submodule sync git submodule update --init
</syntaxhighlight>
To update the submodules, you have to execute the same commands again or pull normally.
