loic/sgp2dot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readme

Browse source
This commit is contained in:
Loic GUEGAN 2019-02-12 18:30:37 +01:00
parent ea82d7ab42
commit 78f05ba362
1 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -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>)`.