Difference between revisions of "Template:ToolGitRepo"
(Start work on a template.) |
m |
||
Line 1: | Line 1: | ||
− | The | + | The {{{repoName}}} repository is available both via release downloads and via github. |
On github, you can both browse and download the latest version of the repository as well as explore the history of changes. | On github, you can both browse and download the latest version of the repository as well as explore the history of changes. | ||
Line 20: | Line 20: | ||
===== Clone (get your own copy) ===== | ===== Clone (get your own copy) ===== | ||
You can create your own git clone (copy) using: | You can create your own git clone (copy) using: | ||
− | git clone https://github.com/statgen/ | + | git clone https://github.com/statgen/{{{repoName}}}.git |
or | or | ||
− | git clone git://github.com/statgen/ | + | git clone git://github.com/statgen/{{{repoName}}}.git |
− | Either of these commands create a directory called <code> | + | Either of these commands create a directory called <code>{{{repoName}}}</code> in the current directory. |
− | Then just <code>cd | + | Then just <code>cd {{{repoName}}}</code> and [[#Building|compile]]. |
===== Get the latest Updates (update your copy) ===== | ===== Get the latest Updates (update your copy) ===== | ||
To update your copy to the latest version (a major advantage of using git): | To update your copy to the latest version (a major advantage of using git): | ||
− | # <code>cd pathToYourCopy/ | + | # <code>cd pathToYourCopy/{{{repoName}}}</code> |
# <code>make clean</code> | # <code>make clean</code> | ||
# <code>git pull</code> | # <code>git pull</code> | ||
Line 42: | Line 42: | ||
Periodically download the latest copy from github from the "Downloads" link on the webpage: https://github.com/statgen/bamUtil/archives/master. | Periodically download the latest copy from github from the "Downloads" link on the webpage: https://github.com/statgen/bamUtil/archives/master. | ||
− | The downloaded tar file is named "statgen- | + | The downloaded tar file is named "statgen-{{{repoName}}}-someHexNumber.tar.gz". The directory created when it is untared shares the same base name. I recommend that you do not change the name of the directory. If you want one called {{{repoName}}}, create a link to this directory. The hex number in the directory name identifies the version of the repository that you downloaded and is necessary to easily troubleshoot any issues you encounter. If you must rename the directory, be sure to record the hex number that was on the download for future reference. |
== Building == | == Building == | ||
− | After obtaining the | + | After obtaining the {{{repoName}}} repository (either by download or from github), compile the code using <code>make all</code>. This creates the executable, <code>{{{exe|{{{repoName}}}}}}</code>, in the <code>{{{repoName}}}/bin/</code> directory, the debug executable in the <code>{{{repoName}}}/bin/debug/</code> directory, and the profiling executable in the <code>{{{repoName}}}/bin/profile/</code> directory. |
Revision as of 10:29, 9 September 2011
The {{{repoName}}} repository is available both via release downloads and via github.
On github, you can both browse and download the latest version of the repository as well as explore the history of changes.
You can access the latest version with or without git.
If you download from github or use git to keep up to date, you also need to download our library: libStatGen.
The releases will be available both with and without libStatGen included. If you download the verison without libStatGen included, you will also need to download libStatGen separately. (It will be available without libStatGen in case you already have a downloaded version of libStatGen that you want to use.
Releases
Release downloads are Coming Soon.
Using github
Using Git To Track the Current Development Version
Clone (get your own copy)
You can create your own git clone (copy) using:
git clone https://github.com/statgen/{{{repoName}}}.git
or
git clone git://github.com/statgen/{{{repoName}}}.git
Either of these commands create a directory called {{{repoName}}}
in the current directory.
Then just cd {{{repoName}}}
and compile.
Get the latest Updates (update your copy)
To update your copy to the latest version (a major advantage of using git):
cd pathToYourCopy/{{{repoName}}}
make clean
git pull
make all
Git Refresher
If you decide to use git, but need a refresher, see How To Use Git or Notes on how to use git (if you have access)
Downloading From GitHub Without Git
Periodically download the latest copy from github from the "Downloads" link on the webpage: https://github.com/statgen/bamUtil/archives/master.
The downloaded tar file is named "statgen-{{{repoName}}}-someHexNumber.tar.gz". The directory created when it is untared shares the same base name. I recommend that you do not change the name of the directory. If you want one called {{{repoName}}}, create a link to this directory. The hex number in the directory name identifies the version of the repository that you downloaded and is necessary to easily troubleshoot any issues you encounter. If you must rename the directory, be sure to record the hex number that was on the download for future reference.
Building
After obtaining the {{{repoName}}} repository (either by download or from github), compile the code using make all
. This creates the executable, {{{repoName}}}
, in the {{{repoName}}}/bin/
directory, the debug executable in the {{{repoName}}}/bin/debug/
directory, and the profiling executable in the {{{repoName}}}/bin/profile/
directory.