152 lines
6.5 KiB
HTML
152 lines
6.5 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
<title>Installation — Git Lint 0.0.4 documentation</title>
|
|
|
|
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT: './',
|
|
VERSION: '0.0.4',
|
|
COLLAPSE_INDEX: false,
|
|
FILE_SUFFIX: '.html',
|
|
HAS_SOURCE: true
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
<link rel="top" title="Git Lint 0.0.4 documentation" href="index.html" />
|
|
<link rel="next" title="Usage" href="usage.html" />
|
|
<link rel="prev" title="Git Lint: README" href="readme.html" />
|
|
</head>
|
|
<body role="document">
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="genindex.html" title="General Index"
|
|
accesskey="I">index</a></li>
|
|
<li class="right" >
|
|
<a href="py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li class="right" >
|
|
<a href="usage.html" title="Usage"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="readme.html" title="Git Lint: README"
|
|
accesskey="P">previous</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<div class="section" id="installation">
|
|
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
|
|
<div class="section" id="stable-release">
|
|
<h2>Stable release<a class="headerlink" href="#stable-release" title="Permalink to this headline">¶</a></h2>
|
|
<p>To install Git Lint, run this command in your terminal:</p>
|
|
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> pip install git_linter
|
|
</pre></div>
|
|
</div>
|
|
<p>If you don’t have <a class="reference external" href="https://pip.pypa.io">pip</a> installed, this <a class="reference external" href="http://docs.python-guide.org/en/latest/starting/installation/">Python installation guide</a> can guide
|
|
you through the process.</p>
|
|
</div>
|
|
<div class="section" id="from-sources">
|
|
<h2>From sources<a class="headerlink" href="#from-sources" title="Permalink to this headline">¶</a></h2>
|
|
<p>The sources for Git Lint can be downloaded from the <a class="reference external" href="https://github.com/elfsternberg/git_linter">Github repo</a>.</p>
|
|
<p>You can either clone the public repository:</p>
|
|
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> git clone git://github.com/elfsternberg/git_linter
|
|
</pre></div>
|
|
</div>
|
|
<p>Or download the <a class="reference external" href="https://github.com/elfsternberg/git_linter/tarball/master">tarball</a>:</p>
|
|
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> curl -OL https://github.com/elfsternberg/git_linter/tarball/master
|
|
</pre></div>
|
|
</div>
|
|
<p>Once you have a copy of the source, you can install it with:</p>
|
|
<div class="highlight-console"><div class="highlight"><pre><span></span><span class="gp">$</span> python setup.py install
|
|
</pre></div>
|
|
</div>
|
|
<p>Once installed, please copy the ‘.git-lint’ example file. You may install this either in
|
|
your home directory as <code class="docutils literal"><span class="pre">.git-lint</span></code> or in your project’s git directory as
|
|
<code class="docutils literal"><span class="pre">.git/lint/git-lint</span></code></p>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
<div class="sphinxsidebarwrapper">
|
|
<h3><a href="index.html">Table Of Contents</a></h3>
|
|
<ul>
|
|
<li><a class="reference internal" href="#">Installation</a><ul>
|
|
<li><a class="reference internal" href="#stable-release">Stable release</a></li>
|
|
<li><a class="reference internal" href="#from-sources">From sources</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="readme.html"
|
|
title="previous chapter">Git Lint: README</a></p>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="usage.html"
|
|
title="next chapter">Usage</a></p>
|
|
<div role="note" aria-label="source link">
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="_sources/installation.txt"
|
|
rel="nofollow">Show Source</a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="searchbox" style="display: none" role="search">
|
|
<h3>Quick search</h3>
|
|
<form class="search" action="search.html" method="get">
|
|
<div><input type="text" name="q" /></div>
|
|
<div><input type="submit" value="Go" /></div>
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="genindex.html" title="General Index"
|
|
>index</a></li>
|
|
<li class="right" >
|
|
<a href="py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li class="right" >
|
|
<a href="usage.html" title="Usage"
|
|
>next</a> |</li>
|
|
<li class="right" >
|
|
<a href="readme.html" title="Git Lint: README"
|
|
>previous</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.4 documentation</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright 2016, Kenneth M. "Elf" Sternberg.
|
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
|
|
</div>
|
|
</body>
|
|
</html> |