#
# NPI - Calculatrice en Notation Polonaise Inverse.
# Copyright (C) 2000-2017 MiKael NAVARRO
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#


Installation
============

Install as root
---------------

To install NPI, simply run the included install script with the
"install" command::

  python setup.py install

or::

  python setup.py install --prefix /usr/local

The package is installed in ``{prefix}/lib/python-version/site-packages/``
and the the doc file in ``{prefix}/share/doc/npi/``.
The main script is installed in ``{prefix}/bin/``.


Install as normal user
----------------------

If you want installation the package as a normal user, run::

  python setup.py install --home $HOME

Note that you have to adjust your PATH and PYTHONPATH environment variables,
eg. by adding the commands ``export PYTHONPATH=$HOME/lib/python``
and ``export PATH=$PATH:$HOME/bin`` to your shell configuration file.

For information on the various options available, use::

   python setup.py --help
   python setup.py --help-commands


Install manually
----------------

If you'd rather do the installation manually, simply move or copy the
directory ``npi-x.x.x/src`` to a location found in your ``PYTHONPATH``.

