diff contrib/splicex/README @ 705:dc8f88270f6a draft

SpliceX update: pyinstall added
author d3v11 <d3v11@d3v11.ano>
date Sat, 29 Oct 2011 10:17:30 -0400
parents a554ba2c1e81
children de6fd9fc14e5
line wrap: on
line diff
--- a/contrib/splicex/README	Fri Oct 28 22:04:07 2011 -0400
+++ b/contrib/splicex/README	Sat Oct 29 10:17:30 2011 -0400
@@ -21,33 +21,71 @@
 
 	d3v11 <d3v11@d3v11.ano>
 
-DEPENDS ON:
 
-	python (>=2.6), python-dev(>=2.6), cython (>=0.12.1), 
-	gcc (>=4.4.3), bash (>=4.1.5), man (>=2.5.7)
 
 (UN)INSTALL:
 
-	SOURCE:
+	You may optionally install splicex with cython. Doing so takes
+	longer to install because of compile times but splicex will
+	also be 20% to 35% faster, depending on your system. I recommend
+	this option if you intend on putting splicex to long-term use.
+	If your goal is simply to test, try, and/or debug splicex then
+	using the pythonic install will be more practical.
+
+	DEPENDS ON:
+
+		python (>=2.6), python-dev(>=2.6), cython (>=0.12.1), 
+		gcc (>=4.4.3), bash (>=4.1.5), man (>=2.5.7)
+
+		SOURCE:
 
-		./configure <python[version]>
-		make compile
-		make install
+			./configure <python[version]>
+			make compile
+			make install
+
+		DEBIAN/UBUNTU:
 
-	DEBIAN/UBUNTU:
+			./configure <python[version]>
+			make compile
+			make install-deb
+
+		UNINSTALL:
+	
+			SOURCE:
+		 		make uninstall
 
-		./configure <python[version]>
-		make compile
-		make install-deb
+			DEBIAN/UBUNTU:
+		 		apt-get remove splicex
+
+PYTHONIC (UN)INSTALL:
+
+	You make optionally install splicex as pure python.
+	Install times are quick but splicex will be 20% to 35%
+	slower than compiling an executable binary with the
+	cython + gcc option above. I recommend using this option
+	if you simply want to test, try, and/or debug splicex.
+
+	DEPENDS ON:
 
-	UNINSTALL:
+		python (>=2.6), bash (>=4.1.5), man (>=2.5.7)
+
+		SOURCE:
+
+			./configure <python[version]> --no-compile
+			make pyinstall
+
+		DEBIAN/UBUNTU:
+
+			./configure <python[version]> --no-compile
+			make pyinstall-deb
+
+		UNINSTALL:
 	
-		source:
-		 make uninstall
+			SOURCE:
+		 		make uninstall
 
-		debian/ubuntu:
-		 apt-get remove splicex
-
+			DEBIAN/UBUNTU:
+		 		apt-get remove splicex
 
 TOOLS: