From 67c2437e63b47fd159969f7da5277a1d5ab36673 Mon Sep 17 00:00:00 2001
From: bnewbold <bnewbold@robocracy.org>
Date: Tue, 1 Mar 2016 22:25:40 -0800
Subject: README, LICENSE, TODO

---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 42 insertions(+), 6 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 8cd198f..14a7013 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,11 @@
 This is a Julia wrapper of the PyX plotting and TeX graphics library from
 Python.
 
-It is a work in progress, broken, and will set your computer on fire.
+It is a work in progress, broken, and will set your computer on fire. See also
+the TODO file.
+
+*Source Code:* https://github.com/bnewbold/PyX.jl
+*Travis CI:* https://travis-ci.org/bnewbold/PyX.jl
 
 ## Example
 
@@ -11,14 +15,37 @@ using PyX
 
 g = graph.graphxy(width=8)
 plot(g, graph_data_function("y(x)=sin(x)/x", min=-15, max=15))
-writeEPSfile(g, "function")
-writePDFfile(g, "function")
-writeSVGfile(g, "function")
 ```
 
-## Install
+There are many (ported) examples in the ./examples/ directory of this
+repository. See the Python PyX upstream documentation for example outputs:
+
+    http://pyx.sourceforge.net/
+
+## Dependencies and Python Version
+
+You'll obviously need the underlying Python PyX library installed, plus any
+dependencies (eg, LaTeX and Ghostscript). These are pretty huge and complex
+packages to install! Use something like Debian's `apt` or Homebrew on OS X. No
+idea how to get this set up on Windows or other platforms.
+
+*NOTE:* PyX versions starting with 0.13 are Python3-only. PyX versions 0.12.1
+and earlier are Python2-only. This split happened back in 2013. This wrapper
+will work with versions on either side of the split, but the newer versions
+(starting with PyX 0.14) support SVG and newer features. Unfortunately,
+switching Julia's PyCall wrapper from Python2 to Python3 is all or nothing.
+Careful! If you decide to do this, run:
+
+    julia> ENV["PYTHON"] = "/usr/bin/python3" # Or your local full path
+    julia> Pkg.build("PyCall")
 
-There are no installation instructions.
+### Install
+
+This package is not (yet) listed in the official Julia MANIFEST.jl index, so
+you'll need to install it "unregistered" style:
+
+    julia> Pkg.clone("https://github.com/bnewbold/PyX.jl")
+    julia> using PyX
 
 ## Notes and Caveats
 
@@ -42,3 +69,12 @@ Also check the TODO file.
 
 For pipeGS (ghostscript file conversion) output, see:
 http://www.ghostscript.com/doc/current/Devices.htm
+
+## License
+
+Following the license of the underlying PyX python library, this wrapper is
+licensed under the GNU GPL Version 2 (or later). See the LICENSE file, and the
+upstream licensing note:
+
+    http://pyx.sourceforge.net/license.html
+
-- 
cgit v1.2.3