Markus Mottl avatar Markus Mottl committed a1f90e4

Rewrote example README

Comments (0)

Files changed (1)

examples/hasse/README.md

-      
-                                        
-                 README: Random generation of Hasse-diagrams
-                 *******************************************
-                  Copyright   (C)   2006  Markus Mottl (1)  
-                  ==========================================
-                      Vienna, 						16th	January, 2006 
-                      =================================
-  
+`hasse` - Random Generation of Hasse-Diagrams
+=============================================
 
-1  Usage information
-*=*=*=*=*=*=*=*=*=*=
+Usage
+-----
 
-  
-  To run this example you need to install the dot-utility first, which you can
-find in the GraphViz-distribution of AT&T:
-  
-      http://www.research.att.com/sw/tools/graphviz
-  
-  This utility can draw directed graphs given a human-readable specification.
-  
-  After compilation of the --hasse---binary (make), just run it, possibly
-setting some options, about which you can learn by entering --hasse -help--.
-This will print a graph-specification as required by the --dot---utility to
-standard output. If you want to visualize this graph, just redirect the
-specification to some file to be read by --dot-- or pipe it to this utility
-directly:
-  
-      hasse | dot -Tps -o foo.ps
-  
-  This will generate a nicely rendered PostScript-file --foo.ps--, which you
-can visualize with your favourite viewer (e.g. --gv--).
-  
-  Play around with some hasse-options to get a feeling for partially ordered
-sets. The implementation of the hasse-tool is very simple and can be easily
-extended to render any kind of partially ordered structure with the
---dot---utility.
-  
+To run this example you need to install the dot-utility first, which you can
+find in the [Graphviz](http://www.graphviz.org) distribution.  This utility
+can draw directed and undirected graphs given a human-readable specification.
 
-2  Contact information
-*=*=*=*=*=*=*=*=*=*=*=
+After compilation of the `hasse.native`-binary (make), just run it, possibly setting
+some options about which you can learn by entering:
 
-  
-  In the case of bugs, feature requests and similar, you can contact me here:
-  
-    markus.mottl@gmail.com
-  
-  Up-to-date information concerning this library should be available here:
-  
-    http://www.ocaml.info/ocaml_sources
-  
-  Enjoy!!
-  
---------------------------------------
-  
- 
- (1) http://www.ocaml.info/
------------------------------------------------------------------------------
-  
-               This document was translated from LaTeX by HeVeA (2).
+    :::sh
+    hasse.native --help
+
+Running `hasse.native` by itself will print a random graph-specification as
+required by the `dot`-utility to standard output.  If you want to visualize
+this graph, just redirect the specification to some file to be read by `dot`
+or pipe it to this utility directly, e.g.:
+
+    :::sh
+    hasse | dot -Tpdf -o foo.pdf
+
+This will generate a nicely rendered PDF-file `foo.pdf`, which you can
+visualize with your favorite viewer.
+
+Play around with some command-line options to get a feeling for partially
+ordered sets.  The implementation of the `hasse`-tool is very simple and can
+be easily extended to render any kind of partially ordered structure with the
+`dot`-utility.
+
+---------------------------------------------------------------------------
+
+Contact Information and Contributing
+------------------------------------
+
+In the case of bugs, feature requests, contributions and similar, you can
+contact me here: <markus.mottl@gmail.com>
+
+Up-to-date information should be available at:
+<https://bitbucket.org/mmottl/pomap>
+
+Enjoy!
+
+Markus Mottl in Rutherford, NJ on July 10, 2012
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.