Package: markdust
markdust=========================.. image:: https://readthedocs.org/projects/markdust/badge/:target: http://markdust.readthedocs.io/en/latest/?badge:alt: Documentation Status.. image:: https://cdn.rawgit.com/thespacedoctor/markdust/master/coverage.svg:target: https://cdn.rawgit.com/thespacedoctor/markdust/master/htmlcov/index.html:alt: Coverage Status*A python package and command-line tools for A bunch of scripts and command-line tools to help with writting notes, blog-posts and slides*.Here's a summary of what's included in the python package:.. include:: /classes_and_functions.rstCommand-Line Usage==================.. code-block:: bashDocumentation for markdust can be found here: http://markdust.readthedocs.org/en/stableUsage:markdust initOptions:init                  setup the markdust settings file for the first time-h, --help            show this help message-v, --version         show version-s, --settings        the settings fileDocumentation=============Documentation for markdust is hosted by `Read the Docs <http://markdust.readthedocs.org/en/stable/>`__ (last `stable version <http://markdust.readthedocs.org/en/stable/>`__ and `latest version <http://markdust.readthedocs.org/en/latest/>`__).Installation============The easiest way to install markdust is to use ``pip``:.. code:: bashpip install markdustOr you can clone the `github repo <https://github.com/thespacedoctor/markdust>`__ and install from a local version of the code:.. code:: bashgit clone git@github.com:thespacedoctor/markdust.gitcd markdustpython setup.py installTo upgrade to the latest version of markdust use the command:.. code:: bashpip install markdust --upgradeDevelopment-----------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:: bashgit clone git@github.com:thespacedoctor/markdust.gitcd markdustpython setup.py develop`Pull requests <https://github.com/thespacedoctor/markdust/pulls>`__are welcomed!Sublime Snippets~~~~~~~~~~~~~~~~If you use `Sublime Text <https://www.sublimetext.com/>`_ as your code editor, and you're planning to develop your own python code with markdust, you might find `my Sublime Snippets <https://github.com/thespacedoctor/markdust-Sublime-Snippets>`_ useful.Issues------Please report any issues`here <https://github.com/thespacedoctor/markdust/issues>`__.License=======Copyright (c) 2016 David YoungPermission is hereby granted, free of charge, to any person obtaining acopy of this software and associated documentation files (the"Software"), to deal in the Software without restriction, includingwithout limitation the rights to use, copy, modify, merge, publish,distribute, sublicense, and/or sell copies of the Software, and topermit persons to whom the Software is furnished to do so, subject tothe following conditions:The above copyright notice and this permission notice shall be includedin all copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESSOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANYCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THESOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.