pip package tweakage, plus md 2 html magic.

Author: ianamason

Makefile

@@ -12,6 +12,11 @@ all:
 	@echo 'To check clang      :    "make check_clang"'
 	@echo 'To check dragonegg  :    "make check_dragonegg"'
 	@echo ''
+	@echo 'To turn md 2 html   :    "make zippity"'
+	@echo ''
+	@echo 'then upload the zip file to https://pypi.python.org/pypi'
+	@echo ''
+
 
 
 #local editable install for developing
@@ -47,6 +52,11 @@ check_dragonegg:
 	cd test; python -m unittest -v test_base_driver test_dragonegg_driver
 
 
+zippity:
+	rm -rf doczip*; mkdir doczip;
+	cat README.md | pandoc -f markdown_github > doczip/index.html
+	zip -r -j doczip.zip doczip
+
 clean:
 	rm -f  wllvm/*.pyc wllvm/*~
 

README.md

@@ -105,16 +105,18 @@ Building a bitcode module with clang
     CC=wllvm ./configure
     make
 
-    # Produces pkg-config.bc
+This should produce the executable `pkg-config`. To extract the bitcode:
+
     extract-bc pkg-config
 
+which will produce the bitcode module `pkg-config.bc`.
+
+
 Tutorials
 =========
 
 A gentler set of instructions on building apache in a vagrant Ubuntu 14.04 can be found
-[here,](https://github.com/SRI-CSL/whole-program-llvm/blob/master/doc/tutorial.md) and
-for Ubuntu 16.04
-[here.](https://github.com/SRI-CSL/whole-program-llvm/blob/master/doc/tutorial-ubuntu-16.04.md)
+[here,](https://github.com/SRI-CSL/whole-program-llvm/blob/master/doc/tutorial.md) and for Ubuntu 16.04 [here.](https://github.com/SRI-CSL/whole-program-llvm/blob/master/doc/tutorial-ubuntu-16.04.md)
 
 Building a bitcode module with dragonegg
 ========================================
@@ -128,9 +130,12 @@ Building a bitcode module with dragonegg
     CC=wllvm ./configure
     make
 
-    # Produces pkg-config.bc
+Again, this should produce the executable `pkg-config`. To extract the bitcode:
+
     extract-bc pkg-config
 
+which will produce the bitcode module `pkg-config.bc`.
+
 
 Building bitcode archive
 ========================
@@ -145,22 +150,30 @@ Building bitcode archive
     # Produces src/LinearMath/libLinearMath.bca
     extract-bc src/LinearMath/libLinearMath.a
 
-    # Produces src/LinearMath/libLinearMath.a.bc
+Note that by default extracting bitcode from an archive produces
+an archive of bitcode. You can also extract the bitcode directly into a module.
+
     extract-bc -b src/LinearMath/libLinearMath.a
 
+produces `src/LinearMath/libLinearMath.a.bc`.
 
 
 
 Building an Operating System
 ============================
 
-To see how to build freeBSD 10.0 from scratch check out this 
-[guide.](../master/doc/tutorial-freeBSD.md)
+To see how to build freeBSD 10.0 from scratch check out this
+[guide.](https://github.com/SRI-CSL/whole-program-llvm/blob/master/doc/tutorial-freeBSD.md)
 
 
 Configuring without building bitcode
 ================================
 
+Sometimes it is necessary to disable the production of bitcode.
+Typically this is during configuration, where the production
+of unexpected files can confuse the configure script. For this
+we have a flag `WLLVM_CONFIGURE_ONLY` which can be used as
+follows:
 
     WLLVM_CONFIGURE_ONLY=1 CC=wllvm ./configure
     CC=wllvm make
@@ -180,9 +193,11 @@ Building a bitcode archive then extracting the bitcode
     extract-bc libjansson.a
     llvm-ar x libjansson.bca
     ls -la
-   
+
 
 
+
+
 Debugging
 =========
 
@@ -214,4 +229,4 @@ it might point out what is wrong.
 License
 =======
 
-WLLVM is released under the MIT license. See the file `LICENSE` for details.
+WLLVM is released under the MIT license. See the file `LICENSE` for [details.](https://github.com/SRI-CSL/whole-program-llvm/blob/master/LICENSE)