diff options
| author | Loic GUEGAN <loic.guegan@yahoo.fr> | 2019-02-12 18:30:37 +0100 |
|---|---|---|
| committer | Loic GUEGAN <loic.guegan@yahoo.fr> | 2019-02-12 18:30:37 +0100 |
| commit | 78f05ba362fc52db5357eaa177603f10ff7bb691 (patch) | |
| tree | b720f02665c28ef1b0fbb6ac4cec020605101c54 | |
| parent | ea82d7ab422e83f21fc4cb499624344328c46340 (diff) | |
Update readme
| -rw-r--r-- | README.md | 16 |
1 files changed, 10 insertions, 6 deletions
@@ -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 <platform-file> <output-dot-file>)` 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 <platform-file> <output-dot-file>)`. |