summarylogtreecommitdiffstats
diff options
context:
space:
mode:
authorJP-Ellis2017-02-09 17:18:26 +1100
committerJP-Ellis2017-02-09 17:20:30 +1100
commit22d39bee993ae8249ce65bdaab40b858fb5f2ecb (patch)
tree59e7d84b777f7e052f3b37d929ee39d987f7d893
parent6d90e52bc7c1775064986873d5bcd95c0104cb6b (diff)
downloadaur-topdrawer.tar.gz
Update Readme
Signed-off-by: JP-Ellis <josh@jpellis.me>
-rw-r--r--README.md23
-rw-r--r--README.org3
2 files changed, 23 insertions, 3 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000000..5b93a3e7a93
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+TopDrawer
+=======
+
+[![AUR badge][AUR badge]][AUR]
+
+TopDrawer installer Arch Linux.
+
+[TopDrawer][homepage] is a SLAC software of which different versions are in
+circulation. For the automatic plotting after event generation MadAnalysis
+needs to be able to cut a topdrawer file in smaller files, convert them to
+postscript files and rotate the single plots automatically to put them in a web
+page. As the syntax for conversion and rotating plots is not the same in all
+version some errors, or even a complete stop of the MadGraph/MadEvent run might
+be expected if a non-default version of topdrawer is used for the automatic
+plotting.
+
+A complete topdrawer reference manual can be found ‚Äčat:
+
+> [Reference Manual](http://www.pa.msu.edu/reference/topdrawer-docs/)
+
+[homepage]: https://cp3.irmp.ucl.ac.be/projects/madgraph/wiki/TopDrawer
+[AUR]: https://aur.archlinux.org/packages/topdrawer/
+[AUR badge]: https://img.shields.io/aur/version/topdrawer.svg
diff --git a/README.org b/README.org
deleted file mode 100644
index e9e8cf26ba5..00000000000
--- a/README.org
+++ /dev/null
@@ -1,3 +0,0 @@
-#+TITLE: TopDrawer [[https://aur.archlinux.org/packages/topdrawer/][https://img.shields.io/aur/version/topdrawer.svg]]
-
-TopDrawer bundled for installation on Arch Linux.