Commit ba3168e1 authored by Ioanna M. Dimitriou H.'s avatar Ioanna M. Dimitriou H. 💬
Browse files

format changeable

parent 6e9516f6
Loading
Loading
Loading
Loading
+10 −15
Changes for README.md: 10 added lines, 15 removed lines.
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ declared in a Common Lisp `<system-name>.asd` file.

* Graphviz (dot should be in `/usr/bin/dot`)

* A Common Lisp REPL (CCL or SBCL tested)
* A Common Lisp REPL (CCL or SBCL, tested)

* Quicklisp

@@ -22,32 +22,27 @@ to your `<system-name>.asd`, then evaluate:

`(asd-graph <file-name>)`

or
optional keywords:

`(asd-graph <file-name> :output-dir <output-dir>)`
`:output-dir <output-dir>` and `:format <fmt>`

This will create a dot and a pdf file in the same directory as 
`<file-name>` or in `<output-dir>` respectively. 

If you prefer a different output (png, svg, `<etc>`), then run
from the same directory as your .dot file, in a terminal, the
following command:

`dot -T<etc> <system-name>.dot -o <output-file-name>`

where `<etc>` is the ending of your preferred format.
This will create a dot and an svg (or `<fmt>` if keyword :format was used) file in the same
directory as `<file-name>`, or in `<output-dir>` if keyword
:output-dir was used.

### Formats supported by dot:

`<fmt>` can take one of the following values:

canon, dot, fig, gd, gif, hpgl, imap, cmap, mif, mp, pcl, pic,
plain (ascii), png, ps, ps2, svg, vrml, vtx, wbmp.

According to the graphviz dot manual: 
http://www.graphviz.org/Documentation/dotguide.pdf

### Supported .ASD formats
### Supported .ASD syntax

For now, only the simplest <system-name>.asd formats are supported,
For now, only the simplest <system-name>.asd syntax is supported,
e.g.:

```common-lisp