Welcome to downloadduxiu's documentation!
+Introduce to downloadduxiu
+.. module:: downloadduxiu
+ :platform: Unix, Windows
+ :synopsis: to download papers from duxiu.
+.. moduleauthor:: luoboiqingcai <firstname.lastname@example.org>
- Install this package<install>
+This **downloadduxiu** package is used to download books either from duxiu or from chaoxing if the book is accessable in your browsers.
+Refer to modules inclued in the package( :ref:`modules included in the package <my-ref>`)
+This package is quite simple and is not necessary to be installed.
+Although some preparations are need:
+ #. python 2.7 installed
+ #. reportlab installed if you want to use gendocument.py script
+modules included in the package
+This is the main module of the package.
+ # prex direction must be created in order to execute this command.
+ ./downloadduxiu.py --prex=prex --logfile=logfile 'yourlink'
+ # utilize multiprocess function
+ ./downloadduxiu.py --prex=prex --logfile=logfile --procnum=2 'yourlink'
+This script is used to preprocess the preface of the ducument in order to make it ordered to be inserted in the pdf document to be generated.
+ # this script must be run first to prepare the prefaces before any images copyed to current direction.
+ ./prefaces.py *.jpg *.png
+This script is used to generate pdf document from images download by downloadduxiu ang prefaces download manually.
+ This script require reportlab installed.
+ # copy preface images prepared in last step to where content page images sit and use command below to generate the whole document.
+ ./gendocument.py --tofile=somename.pdf *.png *.jpg
+This script provides gui for downloadduxiu script.
+ # you have to create a direcotry named "xiazai" where all the python source sit.
+Enter the url you get from your email and click ok to start download.
+When it is finished, "finished" will show in the input area. Clear the input area and fill in your next url to begin a new download.
+This script is the easiest way to utilize this package.