aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..881460b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# Simgrid platform to dot file converter
+
+**sgp2dot** is a [Simgrid](https://simgrid.org) platform to [Graphiz dot file](http://graphviz.org/) convert implemented in Lisp. It require:
+- Common Lisp (supporting asdf)
+- s-xml
+
+How to use it ? Compile it using the following lisp code:
+
+ > (asdf:operate :build-op "sgp2dot")
+Finally invoke `./sgp2dot-cl.lisp <platform-file> <output-dot-file>`
+