Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Just some chat in accompayining text files.

  • Loading branch information...
commit 7935fbd0fb80487c5957697e971d6b2c7ef3b83a 1 parent 8ff9962
@franapoli authored
Showing with 29 additions and 4 deletions.
  1. +6 −2 INSTALL.txt
  2. +23 −2 README.txt
View
8 INSTALL.txt
@@ -1,8 +1,11 @@
+BUILDING AND INSTALLING lglc
+
A Makefile can be generated using cmake (you need to install cmake if
you don't have it already).
-In order to create the Makefile:
+In order to create the Makefile starting from the root directory of
+this package:
> cd build
> cmake ..
@@ -22,6 +25,7 @@ samples directory:
You should get a file named test.lf.dot. If you have Graphviz
installed (http://www.graphviz.org), you can obtain a pdf graph
-visualization:
+visualization this way:
> dot test.lf.dot -o test.pdf
+
View
25 README.txt
@@ -1,3 +1,24 @@
+
+ABOUT lglc
+
This is README.txt file for lglc source package. lglc (Leaf Graph
-Language Compiler) is a compiler for the LGL language using a subset
-of DOT as target.
+Language Compiler) is a compiler for the LGL language whose target
+code is a subset of the DOT language (http://www.graphviz.org). The
+LGL language is an ASCII-ART based graph definition language, whose
+aim is to code graph structures in a readable way. Here is an exmaple:
+
+ /C
+A -> B <
+ \ /E -> @C
+ D <
+ \F -> G, H
+;
+
+The code above defines the graph structure that can be easily
+guessed. Note that the code "E -> @C" creates a loop with the
+previously defined node C. Also note that "F -> G, H" creates two
+edges. The resulting graph can be visualized converting this code to
+DOT language through the lglc compiler and then using Graphviz tools.
+
+The LGL compiler is part of a pipeline management system, so it lacks
+some standalone stuff at the moment (notably documentation).
Please sign in to comment.
Something went wrong with that request. Please try again.