elf
/
git-linter
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
git-linter/docs/installation.rst

52 lines
1.2 KiB
ReStructuredText
Raw Permalink Normal View History

Used cookiecutter to generate a better skeleton for the project, prior to digging in. I realized that I was wrapping my pre-commit hook in a handler to call it outside of the git-commit phase, and what I really wanted was to be able to 'git lint' my repo at any time. This is going to be a new development branch until further notice.
2016-09-19 21:41:01 +00:00
.. highlight:: shell
============
Installation
============
Stable release
--------------
To install Git Lint, run this command in your terminal:
.. code-block:: console
Fixed references to installation.
2016-10-05 16:14:59 +00:00
$ pip install git-linter
Used cookiecutter to generate a better skeleton for the project, prior to digging in. I realized that I was wrapping my pre-commit hook in a handler to call it outside of the git-commit phase, and what I really wanted was to be able to 'git lint' my repo at any time. This is going to be a new development branch until further notice.
2016-09-19 21:41:01 +00:00
If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.
.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
From sources
------------
The sources for Git Lint can be downloaded from the `Github repo`_.
You can either clone the public repository:
.. code-block:: console
Fixed references to installation.
2016-10-05 16:14:59 +00:00
$ git clone git://github.com/elfsternberg/git-linter
Used cookiecutter to generate a better skeleton for the project, prior to digging in. I realized that I was wrapping my pre-commit hook in a handler to call it outside of the git-commit phase, and what I really wanted was to be able to 'git lint' my repo at any time. This is going to be a new development branch until further notice.
2016-09-19 21:41:01 +00:00
Or download the `tarball`_:
.. code-block:: console
Fixed references to installation.
2016-10-05 16:14:59 +00:00
$ curl -OL https://github.com/elfsternberg/git-linter/tarball/master
Used cookiecutter to generate a better skeleton for the project, prior to digging in. I realized that I was wrapping my pre-commit hook in a handler to call it outside of the git-commit phase, and what I really wanted was to be able to 'git lint' my repo at any time. This is going to be a new development branch until further notice.
2016-09-19 21:41:01 +00:00
Once you have a copy of the source, you can install it with:
.. code-block:: console
$ python setup.py install
Fixed references to installation.
2016-10-05 16:14:59 +00:00
.. _Github repo: https://github.com/elfsternberg/git-linter
.. _tarball: https://github.com/elfsternberg/git-linter/tarball/master
Used cookiecutter to generate a better skeleton for the project, prior to digging in. I realized that I was wrapping my pre-commit hook in a handler to call it outside of the git-commit phase, and what I really wanted was to be able to 'git lint' my repo at any time. This is going to be a new development branch until further notice.
2016-09-19 21:41:01 +00:00
I ought to pass my own lint style checks, ne?
2016-10-03 19:31:01 +00:00
Once installed, please copy the '.git-lint' example file. You may install this either in
Fixed references to installation.
2016-10-05 16:14:59 +00:00
your home or repository directory as ``.git-lint``.