Skip to content

Commit

Permalink
documentation: pip2nix -> pip2nix generate
Browse files Browse the repository at this point in the history
  • Loading branch information
ktosiek committed Sep 2, 2015
1 parent 9a6abc6 commit b623046
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 8 deletions.
6 changes: 2 additions & 4 deletions README.rst
Expand Up @@ -39,11 +39,9 @@ Usage

To generate python-packages.nix for a set of requirements::

$ pip2nix -r requirements.txt
$ pip2nix generate -r requirements.txt

``pip2nix`` takes the same set of package specifications ``pip install`` does.

At the moment the --help lies - it's not only showing the ``pip2nix`` options, but also ``pip`` ones (that are not always relevant). (TODO: `#14 <https://github.com/ktosiek/pip2nix/issues/14>`_)
``pip2nix generate`` takes the same set of package specifications ``pip install`` does.

Contact
=======
Expand Down
2 changes: 1 addition & 1 deletion bootstrap.sh
Expand Up @@ -37,4 +37,4 @@ if [ "$FORCE_REBUILD" -o \
touch ./_bootstrap_env/.done
fi

./_bootstrap_env/bin/pip2nix
./_bootstrap_env/bin/pip2nix generate
6 changes: 3 additions & 3 deletions docs/getting_started.rst
Expand Up @@ -14,9 +14,9 @@ Ad-hoc python-packages.nix generation

To generate python-packages.nix for a set of requirements::

$ pip2nix -r requirements.txt
$ pip2nix generate -r requirements.txt

``pip2nix`` takes the same set of package specifications ``pip install`` does.
``pip2nix generate`` takes the same set of package specifications ``pip install`` does.
It understands ``-r``, git links, package specifications, and ``-e`` (which is just ignored).

Using pip2nix in a project
Expand All @@ -28,5 +28,5 @@ To do that, you can create a ``pip2nix.ini`` file::
[pip2nix]
requirements = -r ./requirements.txt

This way you can only run ``pip2nix`` in the project's root.
This way you can just run ``pip2nix generate`` in the project's root.
More about the configuration file in :doc:`configuration`.

0 comments on commit b623046

Please sign in to comment.