Skip to content

Commit 4fca668

Browse files
committed
DOC: Enhanced README, added LICENSE.
1 parent ef0391c commit 4fca668

File tree

5 files changed

+42
-15
lines changed

5 files changed

+42
-15
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
*~
21
README.html
32
README.pdf
43
README.tex

LICENSE.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2017 Wouter Beek
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

README.org

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,34 @@
77
#+HTML_HEAD: <script type="text/javascript" src="https://www.pirilampo.org/styles/lib/js/jquery.stickytableheaders.js"></script>
88
#+HTML_HEAD: <script type="text/javascript" src="https://www.pirilampo.org/styles/readtheorg/js/readtheorg.js"></script>
99

10-
A simple graph export library for SWI-Prolog.
10+
A library for exporting graphs from SWI-Prolog. Currently the
11+
following formats are supported:
12+
13+
- GraphViz DOT
14+
- Graph Markup Language (GML)
15+
16+
Please report any issues that you find when using this library.
1117

1218
* Installation
1319

1420
1. Install [[http://www.swipl-prolog.org][SWI-Prolog]].
15-
2. Install GraphViz:
16-
+ ~$ sudo apt install graphviz~ on Debian-based distro's, e.g., Ubuntu.
17-
+ ~$ sudo dnf install graphviz~ on Red Hat-based distro's, e.g., Fedora.
18-
3. Start SWI-Prolog and install this library through the Prolog
19-
package manager:
20-
~pack_install('git://github.com/wouterbeek/graph_export').~
21+
2. Install [[https://github.com/wouterbeek/Prolog-Library-Collection][Prolog-Library-Collection]].
22+
3. Clone this library: ~git clone https://github.com/wouterbeek/graph_export~
23+
4. Add the following line to your ~.swiplrc~ file:
24+
25+
#+BEGIN_SRC prolog
26+
user:file_search_path(library, '/your/path/to/graph_export/prolog').
27+
#+END_SRC
28+
29+
In order to generate DOT visualizations, install GraphViz:
30+
31+
- ~$ sudo apt install graphviz~ on Debian-based distro's (e.g., Ubuntu).
32+
- ~$ sudo dnf install graphviz~ on Red Hat-based distro's (e.g., Fedora).
2133

2234
* Simple usage
2335

24-
Once installed, this library can by imported with the following
25-
command:
36+
Once installed, modules from this library can by imported in the
37+
following way:
2638

2739
#+BEGIN_SRC prolog
2840
?- [library(graph/gv)].

debug.pl

Lines changed: 0 additions & 4 deletions
This file was deleted.

prolog/graph/dot_html.pl

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
:- encoding(utf8).
32
:- module(
43
dot_html,

0 commit comments

Comments
 (0)