Changes

From Genome Analysis Wiki
Jump to navigationJump to search

Template:ToolGitRepo (view source)

Revision as of 00:18, 13 November 2017

1,223 bytes added ,  00:18, 13 November 2017
no edit summary
Line 1: Line 1: −
The {{{repoName}}} repository is available {{{noDownload|both via [[#Releases|release downloads]] and}}} via github.
+
{{#if: {{{noDownload|}}} |  | The {{{repoName}}} repository is available both via [[#Releases|release downloads]] and via github.}}
   −
On github, https://github.com/statgen/{{{repoName}}}, you can both browse and download the latest version of the repository as well as explore the history of changes.
+
On github, https://github.com/statgen/{{{repoName}}}, you can both browse and download the {{{repoName}}} source code as well as explore the history of changes.
−
 
  −
You can access the latest version with or without git.
      +
You can obtain the source either with or without git.
    +
{{#if: {{{nolibStatGen|}}} | |
 
{{#if: {{{libStatGen|}}} | A copy of libStatGen is included in certain releases of some statgen tools. |
 
{{#if: {{{libStatGen|}}} | A copy of libStatGen is included in certain releases of some statgen tools. |
 
The releases may be available both with and without libStatGen included.   
 
The releases may be available both with and without libStatGen included.   
Line 19: Line 19:  
** See [[C++ Library: libStatGen|libStatGen]]
 
** See [[C++ Library: libStatGen|libStatGen]]
 
}}
 
}}
−
 
+
}}
    
=== Using Git To Track the Current Development Version ===
 
=== Using Git To Track the Current Development Version ===
Line 45: Line 45:     
=== Downloading From GitHub Without Git ===
 
=== 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.
+
If you download the latest code/version, make sure you periodically update it by downloading a newer version.
 +
 
 +
From github you can download:
 +
# Latest Code (master branch)
 +
#: via Website
 +
#:# Goto: https://github.com/statgen/{{{repoName}}}
 +
#:# Click on the <code>Download ZIP</code> button on the right side panel.
 +
#: via Command Line
 +
#:: <code>wget https://github.com/statgen/{{{repoName}}}/archive/master.tar.gz</code>
 +
#::: or
 +
#:: <code>wget https://github.com/statgen/{{{repoName}}}/archive/master.zip</code>
 +
# Specific Release (via a tag)
 +
#: via Website
 +
#:# Goto: https://github.com/statgen/{{{repoName}}}/releases to see the available releases
 +
#:# Click <code>zip</code> or <code>tar.gz</code> for the desired version.
 +
#: via Command Line
 +
#:: <code>wget https://github.com/statgen/{{{repoName}}}/archive/<tagName>.tar.gz</code>
 +
#::: or
 +
#:: <code>wget https://github.com/statgen/{{{repoName}}}/archive/<tagName>.zip</code>
 +
{{#if: {{{latestReleaseBranch|}}} |
 +
#Latest Release (via a branch)
 +
#: via Website
 +
#:# Goto: https://github.com/statgen/{{{repoName}}}/tree/{{{latestReleaseBranch}}} to see the latest release
 +
#:# Click on the <code>Download ZIP</code> button on the right side panel.
 +
#: via Command Line
 +
#:: <code>wget https://github.com/statgen/{{{repoName}}}/archive/{{{latestReleaseBranch}}}.tar.gz</code>
 +
#::: or
 +
#:: <code>wget https://github.com/statgen/{{{repoName}}}/archive/{{{latestReleaseBranch}}}.zip</code>
 +
}}
   −
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.
+
After downloading the file, uncompress (unzip/untar) it. The directory created will be named <code>{{{repoName}}}-<name of version you downloaded></code>.
    +
{{#if: {{{skipBuild|}}}||
 
== Building ==
 
== Building ==
 
After obtaining the {{{repoName}}} repository (either by download or from github), compile the code using:
 
After obtaining the {{{repoName}}} repository (either by download or from github), compile the code using:
Line 66: Line 95:     
To see all make options, type <code>make help</code>.
 
To see all make options, type <code>make help</code>.
 +
}}
 +
 +
 +
If compilation fails due to warnings being treated as errors, please contact us so we can fix the warnings.  As a work-around to get it to compile, you can disable the treatment of warnings as errors by editing libStatGen/general/Makefile to remove <code>-Werror</code>.
Retrieved from "http://genome.sph.umich.edu/wiki/Special:MobileDiff/4264...14942"

Navigation menu