Add fully markdown support inside box and not content, issue#26

README.md

@@ -1,9 +1,10 @@
  <a name="top"></a>
 # MaTiSSe.py [![Latest Version](https://pypip.in/version/MaTiSSe.py/badge.svg?style=flat)](https://pypi.python.org/pypi/MaTiSSe.py/) [![GitHub tag](https://img.shields.io/github/tag/szaghi/MaTiSSe.svg)]()
+# MaTiSSe.py [![Latest Version](https://img.shields.io/pypi/v/MaTiSSe.py.svg)](https://img.shields.io/pypi/v/MaTiSSe.py.svg) [![GitHub tag](https://img.shields.io/github/tag/szaghi/MaTiSSe.svg)]()
 
 [![Join the chat at https://gitter.im/szaghi/MaTiSSe](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/szaghi/MaTiSSe?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-[![License](https://pypip.in/license/MaTiSSe.py/badge.svg?style=flat)](https://pypi.python.org/pypi/MaTiSSe.py/)
+[![License](https://img.shields.io/badge/license-GNU%20GeneraL%20Public%20License%20v3,%20GPLv3-blue.svg)]()
 
 ### MaTiSSe.py, Markdown To Impressive Scientific Slides
 MaTiSSe.py is a very simple and stupid (KISS) presentation maker based on simple `markdown` syntax producing high quality first-class html/css presentation with great support for scientific contents.
@@ -14,7 +15,7 @@ MaTiSSe.py is a very simple and stupid (KISS) presentation maker based on simple
 + MaTiSSe.py is a Free, Open Source Project.
 
 ### Status
-[![Development Status](https://pypip.in/status/MaTiSSe.py/badge.svg?style=flat)](https://pypi.python.org/pypi/MaTiSSe.py/)
+
 [![Build Status](https://travis-ci.org/szaghi/MaTiSSe.svg?branch=master)](https://travis-ci.org/szaghi/MaTiSSe)
 [![Coverage Status](https://img.shields.io/coveralls/szaghi/MaTiSSe.svg)](https://coveralls.io/r/szaghi/MaTiSSe)
 [![Code Health](https://landscape.io/github/szaghi/MaTiSSe/master/landscape.svg?style=flat)](https://landscape.io/github/szaghi/MaTiSSe/master)
@@ -25,7 +26,7 @@ MaTiSSe.py is a very simple and stupid (KISS) presentation maker based on simple
 [![In Progress](https://badge.waffle.io/szaghi/matisse.png?label=in%20progress&title=In%20Progress)](https://waffle.io/szaghi/matisse)
 [![Open bugs](https://badge.waffle.io/szaghi/matisse.png?label=bug&title=Open%20Bugs)](https://waffle.io/szaghi/matisse)
 
-#### Python support [![Supported Python versions](https://pypip.in/py_versions/MaTiSSe.py/badge.svg?style=flat)](https://pypi.python.org/pypi/MaTiSSe.py/) [![Download format](https://pypip.in/format/MaTiSSe.py/badge.svg?style=flat)](https://pypi.python.org/pypi/MaTiSSe.py/)
+#### Python support [![Supported Python versions](https://img.shields.io/badge/Py-%202.7,%203.4-blue.svg)]()
 
 #### Documentation
 
@@ -48,21 +49,44 @@ See MaTiSSe.py in action with the [getting started presentation](http://szaghi.g
 
 Go to [Top](#top)
 
-## Team Members
-* Stefano Zaghi, aka _szaghi_ <https://github.com/szaghi>
-
-### Contributors
-* not yet... be the first!
-
-Go to [Top](#top)
-
-## <a name="versions"></a>Versions History
-In the following the changelog of most important releases is reported.
-### v0.0.2
-##### Download [ZIP](https://github.com/szaghi/MaTiSSe/archive/v0.0.2.zip) ball or [TAR](https://github.com/szaghi/MaTiSSe/archive/v0.0.2.tar.gz) one
-STABLE release. Fully backward compatible. Add PyPI installation support.
-### v0.0.1
-##### Download [ZIP](https://github.com/szaghi/MaTiSSe/archive/v0.0.1.zip) ball or [TAR](https://github.com/szaghi/MaTiSSe/archive/v0.0.1.tar.gz) one
-First, STABLE release.
+## Main Features
+MaTiSSe.py has a too much long list of features. Here the main features are listed whereas for a complete list read all the documentation material (examples, wiki, etc...).
+
+* [x] `markdown-to-html` slides maker (with extended markdown syntax);
+* [ ] support for structured, long presentations:
+    * [x] presentation metadata;
+    * [x] presentation sectioning:
+        * [x] `titlepage`;
+        * [x] `section`;
+        * [x] `subsection`;
+        * [x] `slide`;
+    * [ ] helpers:
+        * [x] `TOC`;
+        * [x] `countdown timer`;
+        * [ ] `navigation controls`;
+* [x] easy theming:
+    * [x] `canvas`;
+    * [x] `headings` (h1,h2,...);
+    * [x] global slide theme as well theme of a specific slide (local slide theme):
+        * [x] `headers` (unlimited number);
+        * [x] `footers` (unlimited number);
+        * [x] `left and right sidebars` (unlimited number);
+        * [x] `content`;
+    * [x] `beamer-like-styles` support;
+* [x] `latex equations` support;
+* [x] `scientific contents` support:
+    * [x] `boxes` with fully customizable environment;
+    * [x] `figures` with fully customizable environment;
+    * [ ] `tables` with fully customizable environment;
+    * [x] `notes` with fully customizable environment;
+    * [x] `code listings` with syntax highlighting;
+    * [x] `columns` fully customizable environment;
+* [ ] `note handouts` support;
+* [x] `impress.js` support;
+* [ ] `jmpress.js` support;
+* [ ] `reveal.js` support;
+
+## Copyrights
+MaTiSSe.py is an open source project, it is distributed under the [GPL v3](http://www.gnu.org/licenses/gpl-3.0.html) license. A copy of the license should be distributed within MaTiSSe.py. Anyone interested to use, develop or to contribute to MaTiSSe.py is welcome. Take a look at the [contributing guidelines](CONTRIBUTING.md) for starting to contribute to the project.
 
 Go to [Top](#top)

release/MaTiSSe-0.3.0/CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# How to contribute
+
+This project is open source, therefore, anyone interested to use, to develop or to contribute to it is welcome.
+
+The project must remain KISS (Keep It Simple and Stupid) thus a few guidelines for contributing are provided.
+
+## Issues Handling
+
+If you find issues (bugs or new features requests) you are kindly requested to highlight them on the GitHub repository.
+
++ Make sure you have a [GitHub account](https://github.com/signup/free);
++ submit a ticket for your issue, assuming one does not already exist;
+  + clearly describe the issue including steps to reproduce when it is a bug;
+  + make sure you fill in the earliest version that you know has the issue.
+
+Alternatively, you can signal issues directly to the main developer at stefano.zaghi@gmail.com.
+
+## Collaborative Development
+
+If you like to directly contribute to the project you are welcome. To improve the collaborative development of the project you are kindly requested to respect the following guidelines.
+
++ Fork the repository on GitHub;
++ create a topic branch from where you want to base your work;
+  + this is usually the master branch:
+  + only target release branches if you are certain your fix must be on that branch;
+  + to quickly create a topic branch based on master; `git branch fix/master/my_contribution master` then checkout the new branch with `git checkout fix/master/my_contribution`; please avoid working directly on the `master` branch;
++ check for unnecessary whitespace with `git diff --check` before committing;
++ make sure your commit messages are clear;
++ make sure you have properly tested for your changes.
+
+As long as possible, contributors are kindly requested to follow the current coding style of the project (two white spaces instead of tabs, no trailing white spaces, blank lines should not have any space). In general, it is strongly recommended to avoid Microsoft-Windows-like carriage-return symbols in order to not pollute the source files with unnecessary symbols.