diff README.md @ 4:363cd315d0e9 draft

Uploaded
author saskia-hiltemann
date Mon, 16 Nov 2015 09:46:51 -0500
parents 3c160414da2e
children 3c697a0bc415
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Mon Nov 16 09:46:51 2015 -0500
@@ -0,0 +1,30 @@
+iReport
+=======
+
+iReport Galaxy tool - HTML reporting in Galaxy
+
+install to your Galaxy via the main tool shed: http://toolshed.g2.bx.psu.edu/
+
+direct repository link:  http://saskia-hiltemann@toolshed.g2.bx.psu.edu/repos/saskia-hiltemann/ireport
+
+email: s.hiltemann@erasmusmc.nl
+
+
+Installation Instructions
+--------------------------
+This package uses (but does not install) Bash, Perl and Python. 
+
+If Pandoc ((johnmacfarlane.net/pandoc/index.html)) is installed on your system PATH (command 'pandoc'), any MarkDown text items will be rendered using Pandoc (allows many markdown syntax extensions). 
+If Pandoc is not present, a simple markdown conversion script is used (only handles vanilla syntax).
+
+
+TODOs
+---------------
+- ~~option to download iReport webpage~~
+- ~~markdown instead of plain text/html in text fields.~~
+- Support for large tables
+- Multiple columns in table converted to weblinks.
+- Table colums link to archive files in history
+- ..
+- ..suggestions?
+