Changes

From Genome Analysis Wiki
Jump to navigationJump to search

Template:ToolGitRepo (view source)

Revision as of 00:18, 13 November 2017

459 bytes added ,  00:18, 13 November 2017
no edit summary
Line 1: Line 1: −
The {{{repoName}}} repository is available {{#if: {{{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: {{{nolibStatGen|}}} | |
Line 45: Line 45:     
=== Downloading From GitHub Without Git ===
 
=== Downloading From GitHub Without Git ===
 +
If you download the latest code/version, make sure you periodically update it by downloading a newer version.
 +
 
From github you can download:
 
From github you can download:
 
# Latest Code (master branch)
 
# 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)
 
# Specific Release (via a tag)
−
{{#if: {{{latestReleaseBranch|}}} | #Latest Release (via a branch) }}
+
#: via Website
−
 
+
#:# Goto: https://github.com/statgen/{{{repoName}}}/releases to see the available releases
−
==== Downloading a Released Version ====
+
#:# Click <code>zip</code> or <code>tar.gz</code> for the desired version.
−
You can download a specific release from github.  To see the releases available, go to: https://github.com/statgen/{{{repoName}}}/releases
+
#: via Command Line
−
 
+
#:: <code>wget https://github.com/statgen/{{{repoName}}}/archive/<tagName>.tar.gz</code>
−
You can either download via:
+
#::: or
−
* Website
+
#:: <code>wget https://github.com/statgen/{{{repoName}}}/archive/<tagName>.zip</code>
−
*:Click on <code>zip</code> or <code>tar.gz</code> to download that version.
+
{{#if: {{{latestReleaseBranch|}}} |
−
* Command Line
+
#Latest Release (via a branch)
−
* wget https://github.com/statgen/{{{repoName}}}/archive/<tagName>.tar.gz
+
#: 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>
 +
}}
   −
==== Downloading the Latest Version ====
+
After downloading the file, uncompress (unzip/untar) it. The directory created will be named <code>{{{repoName}}}-<name of version you downloaded></code>.
−
 
  −
Periodically download the latest copy from github.
  −
 
  −
You can either download the latest copy via:
  −
* Website
  −
*:Click on <code>zip</code> or <code>tar.gz</code> to download that version.
  −
* Command Line
  −
* wget https://github.com/statgen/{{{repoName}}}/archive/master.tar.gz
  −
 
  −
 
  −
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.
      +
{{#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 89: 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/8075...14942"

Navigation menu