From 78f05ba362fc52db5357eaa177603f10ff7bb691 Mon Sep 17 00:00:00 2001 From: Loic GUEGAN Date: Tue, 12 Feb 2019 18:30:37 +0100 Subject: [PATCH] Update readme --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index abdafd0..73e166f 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,17 @@ # 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 requires: -- Common Lisp (Implementation supporting asdf) -- s-xml +**sgp2dot** is a [Simgrid](https://simgrid.org) platform to [Graphiz dot file](http://graphviz.org/) converter implemented in Common Lisp. It requires: +- Common Lisp +- [ASDF](https://common-lisp.net/project/asdf/) (Another System Definition Facility) +- [S-XML](https://common-lisp.net/project/s-xml/) (Simple XML parser) -How to use it ? Compile it using the following lisp code: +### How to use it ? +- **First solution:** Compile the project using *asdf* with the following call: > (asdf:operate :build-op "sgp2dot") -Finally invoke `(convert )` or use the dedicated *sgp2dot-cl.lisp* -in your CLI. Note that you should change the *sgp2dot-cl.lisp* shebang according to your lisp implementation. + Then, use the dedicated *sgp2dot-cl.lisp* in your CLI. Note that you should + adapt the *sgp2dot-cl.lisp* shebang according to your lisp implementation. +- **Second, and simpler solution:** Load the system using *asdf*, and invoke + `(sgp2dot:convert )`.