From f12b746ade7ec2ef5461fd681e424440392e62ec Mon Sep 17 00:00:00 2001 From: "Kenneth M. Elf Sternberg" Date: Wed, 5 Oct 2016 09:14:59 -0700 Subject: [PATCH] Fixed references to installation. --- README.rst | 11 +++++++++++ docs/installation.rst | 13 ++++++------- 2 files changed, 17 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index fd1710d..3670192 100644 --- a/README.rst +++ b/README.rst @@ -46,6 +46,8 @@ Linter Docs `_. 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 -------- diff --git a/docs/installation.rst b/docs/installation.rst index cfb390b..9ed3a8d 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -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``.