| 5 | | You can download the BOINC source code as a compressed archive from here: |
| 6 | | https://github.com/BOINC/boinc-v2/releases |
| 7 | | |
| 8 | | You can browse the BOINC source code using [/browser a web-based interface] |
| 9 | | ([http://boinc.berkeley.edu/gitweb/ alternative]). |
| 10 | | This is useful for getting individual files or viewing the revision history. |
| 11 | | |
| 12 | | == Getting the code via Git == |
| 13 | | |
| 14 | | The BOINC source code is stored in a [http://www.git-scm.com Git] repository. |
| 15 | | To clone the repository into a directory called (for example) 'boinc', run: |
| | 5 | The BOINC source code now maintained in [http://www.git-scm.com Git] repositories: |
| | 6 | |
| | 7 | * There is a [https://github.com/BOINC/boinc BOINC Git repository] at [http://en.wikipedia.org/wiki/GitHub github]. In particular, you can download the BOINC v2 source code as a compressed archive from [https://github.com/BOINC/boinc-v2/releases here]. |
| | 8 | * There is a [http://boinc.berkeley.edu/gitweb/ BOINC Git repository] at berkeley.edu. |
| | 9 | |
| | 10 | ''(If anyone knows what the exact relationship is between these repos, please do tell. Also. This [/browser old URL] evidently has decayed and doesn't work anymore.) |
| | 11 | |
| | 12 | Both sites allow you to browse the source trees. This is useful for getting individual files or viewing the revision history. |
| | 13 | |
| | 14 | = Getting the code directly using Git = |
| | 15 | |
| | 16 | It is easier to get the source as a tarball or zipfile as indicated above. However, you may want to use Git directly instead. |
| | 17 | |
| | 18 | == Installing Git == |
| | 19 | |
| | 20 | * On Windows, get a Git client like 'Git for Windows' (console) or !TortoiseGit (GUI) |
| | 21 | (see this [SourceCodeGit/Windows guide for Windows]). |
| | 22 | * On Linux, Git is usually provided by your distribution. |
| | 23 | If it is not already installed, check your distribution's package manager and look for package "git" or "git-core". |
| | 24 | * On Mac OS X, use [http://www.macports.org MacPorts] |
| | 25 | (to keep Git up to date, recommended) or a manual |
| | 26 | [http://code.google.com/p/git-osx-installer installation package]. |
| | 27 | * Recommended free GUIs: [http://www.sourcetreeapp.com SourceTree (includes an embedded Git)], |
| | 28 | [http://www.syntevo.com/smartgit/ SmartGit (free for non-commercial use)], |
| | 29 | [http://gitx.laullon.com GitX] ([https://github.com/laullon/gitx latest]) |
| | 30 | |
| | 31 | You don't need to fully understand Git; just skim the instructions below. If you intend to modify BOINC or to look at branches, you'll need to know at least the basics. |
| | 32 | |
| | 33 | Recommended reading/watching: |
| | 34 | |
| | 35 | * vimeo.com/14629850 (Getting Git): 1 hour video (technical, but highly recommended) ''(Live link temporarily removed because Trac complains about too many links and suspects spam) |
| | 36 | * git-scm.com/book (Pro Git): Great free online book (also commercially available in print!) ''(Live link temporarily removed because Trac complains about too many links and suspects spam) |
| | 37 | * git-scm.com/doc (All the rest): Cheat sheets, tutorials and more videos ''(Live link temporarily removed because Trac complains about too many links and suspects spam) |
| | 38 | |
| | 39 | == Cloning the remote Git repository == |
| | 40 | |
| | 41 | To clone the repository into a local directory called (for example) 'boinc', run one of these console commands: |
| 27 | | On Windows, you'll need a Git client such as !TortoiseGit (see below). |
| 28 | | Right-click on the parent directory, select 'Git Clone...', and fill in the dialog with one of the above URLs. |
| 29 | | Don't forget to remove both 'git clone' and 'boinc' from the commands above. |
| 30 | | |
| 31 | | The 'clone' operation pulls down ~134 MB of source and gives you a copy that you can modify and compile locally. |
| | 53 | On Windows using !TortoiseGit, right-click on the parent directory, select 'Git Clone...', and fill in the dialog with one of the above URLs. |
| | 54 | Don't forget to remove both 'git clone' and 'boinc' from the commands above. |
| | 55 | |
| | 56 | The 'clone' operation pulls down ~150 MiB of source and gives you a copy that you can modify and compile locally. |
| 115 | | === Installing Git === |
| 116 | | |
| 117 | | To access the BOINC Git repository you'll need the Git client software: |
| 118 | | |
| 119 | | * On Windows, get a Git client like 'Git for Windows' (console) and !TortoiseGit (GUI) |
| 120 | | (see this [SourceCodeGit/Windows guide for Windows]). |
| 121 | | * On Linux, Git is usually provided by your distribution. |
| 122 | | If it is not already installed, check your package manager and look for "git" or "git-core". |
| 123 | | * On Mac OS X, use [http://www.macports.org MacPorts] |
| 124 | | (to keep Git up to date, recommended) or a manual |
| 125 | | [http://code.google.com/p/git-osx-installer installation package]. |
| 126 | | * Recommended free GUIs: [http://www.sourcetreeapp.com SourceTree (includes an embedded Git)], |
| 127 | | [http://www.syntevo.com/smartgit/ SmartGit (free for non-commercial use)], |
| 128 | | [http://gitx.laullon.com GitX] ([https://github.com/laullon/gitx latest]) |
| 129 | | |
| 130 | | To get a copy of the BOINC source code you don't need to fully understand Git; |
| 131 | | just skim the instructions below. |
| 132 | | However, if you intend to modify BOINC or to look at branches, you'll need to know at least the basics. |
| 133 | | |
| 134 | | Recommended reading/watching: |
| 135 | | |
| 136 | | * [http://vimeo.com/14629850 Getting Git]: 1 hour video (technical, but highly recommended) |
| 137 | | * [http://git-scm.com/book Pro Git]: Great free online book (also commercially available in print!) |
| 138 | | * [http://git-scm.com/doc All the rest]: Cheat sheets, tutorials and more videos |
| 139 | | |
| 140 | | == Tags & Branches == |
| | 142 | === Tags & Branches === |
