deckster 0.2

deckster
=========================

*CL tools to build a Reveal.js presentation from a single Multimarkdown file*.

Usage
========

<<<<<<< Updated upstream
.. todo::
=======
.. code-block:: bash

deckster init <destinationPath> [-s <pathToSettingsFile>]
>>>>>>> Stashed changes

- add usage

Documentation
=============

Documentation for deckster is hosted by `Read the Docs <http://deckster.readthedocs.org/en/stable/>`__ (last `stable version <http://deckster.readthedocs.org/en/stable/>`__ and `latest version <http://deckster.readthedocs.org/en/latest/>`__).

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

The easiest way to install deckster us to use ``pip``:

.. code:: bash

pip install deckster

Or you can clone the `github repo <https://github.com/thespacedoctor/deckster>`__ and install from a local version of the code:

.. code:: bash

git clone git@github.com:thespacedoctor/deckster.git
cd deckster
python setup.py install

To upgrade to the latest version of deckster use the command:

.. code:: bash

pip install deckster --upgrade


Development
-----------

If you want to tinker with the code, then install in development mode.
This means you can modify the code from your cloned repo:

.. code:: bash

git clone git@github.com:thespacedoctor/deckster.git
cd deckster
python setup.py develop

`Pull requests <https://github.com/thespacedoctor/deckster/pulls>`__
are welcomed!


Issues
------

Please report any issues
`here <https://github.com/thespacedoctor/deckster/issues>`__.

License
=======

Copyright (c) 2016 David Young

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.