Skip to content

Commit

Permalink
Updates installation docs and faq
Browse files Browse the repository at this point in the history
  • Loading branch information
shidarin committed Jun 15, 2014
1 parent 7a2a598 commit 186d6e8
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 11 deletions.
8 changes: 4 additions & 4 deletions docs/faq.rst
Expand Up @@ -31,10 +31,10 @@ Project Structure
``cdl_convert`` started as a simple script to convert from one format to
another. As such, it wasn't named with the standards that one would usually
use for a python module. By the time the project became big enough, was on
PyPI, etc, it was too spread out, in too many places to make changing easy.
In the end, I opted to keep it. At some point, ``cdl_convert`` might migrate
into a larger, more generic film & tv python module, which will be named
properly.
PyPI, etc, it was too spread out on the web, in too many places to make
changing easy. In the end, I opted to keep it. At some point,
``cdl_convert`` might migrate into a larger, more generic film & tv
python module, which will be named properly.

.. _Travis-ci.org: http://travis-ci.org/shidarin/cdl_convert
.. _coveralls.io: http://coveralls.io/r/shidarin/cdl_convert
Expand Down
10 changes: 3 additions & 7 deletions docs/installation.rst
Expand Up @@ -14,13 +14,9 @@ Script Only Installation
========================

If you don't want to bother with a pip style install, you can alternatively
grab `cdl_convert/cdl_convert.py`_, as this file is the script and all the
functions and classes needed.

You will need to place the python file somewhere (such as a ``bin`` folder),
and either run the script by directly invoking the file directly or creating
an alias to the file location.
grab the entire `cdl_convert`_ directory, then set up a shortcut to call
``cdl_convert/cdl_convert.py``

Creating aliases, etc are beyond the scope of this documentation.

.. _cdl_convert/cdl_convert.py: http://github.com/shidarin/cdl_convert/blob/master/cdl_convert/cdl_convert.py
.. _cdl_convert: http://github.com/shidarin/cdl_convert/

0 comments on commit 186d6e8

Please sign in to comment.