elf
/
git-linter
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fixed references to installation.

This commit is contained in:
Elf M. Sternberg 2016-10-05 09:14:59 -07:00
parent 4895dde1b6
commit f12b746ade
2 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.rst
View File

@ -46,6 +46,8 @@ Linter Docs <https://elfsternberg.github.io/git-linter/index.html>`_.
Install
-------
This *ought* to work:
`pip install git-linter`
You will need to copy the .git-lint configuration file to either your
@ -53,6 +55,15 @@ home directory or the repo`s base directory. Edit the configuration
file as needed. You will also need any linters that you plan on
running.
As git-linter is still mostly alpha code, it might be better to install
from source:
``
git clone https://github.com/elfsternberg/git-linter
python setup.py install
``
Features
--------

13
docs/installation.rst
View File

@ -12,7 +12,7 @@ To install Git Lint, run this command in your terminal:
.. code-block:: console
$ pip install git_linter
$ pip install git-linter
If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.
@ -30,13 +30,13 @@ You can either clone the public repository:
.. code-block:: console
$ git clone git://github.com/elfsternberg/git_linter
$ git clone git://github.com/elfsternberg/git-linter
Or download the `tarball`_:
.. code-block:: console
$ curl -OL https://github.com/elfsternberg/git_linter/tarball/master
$ curl -OL https://github.com/elfsternberg/git-linter/tarball/master
Once you have a copy of the source, you can install it with:
@ -44,9 +44,8 @@ Once you have a copy of the source, you can install it with:
$ python setup.py install
.. _Github repo: https://github.com/elfsternberg/git_linter
.. _tarball: https://github.com/elfsternberg/git_linter/tarball/master
.. _Github repo: https://github.com/elfsternberg/git-linter
.. _tarball: https://github.com/elfsternberg/git-linter/tarball/master
Once installed, please copy the '.git-lint' example file. You may install this either in
your home directory as ``.git-lint`` or in your project's git directory as
``.git/lint/git-lint``
your home or repository directory as ``.git-lint``.