diff --git a/Makefile b/Makefile new file mode 100644 index 0000000000..c714115065 --- /dev/null +++ b/Makefile @@ -0,0 +1,15 @@ +TRAC_ROOT=/var/lib/trac/libprs500/htdocs/apidocs + +all: doc sdist egg + +sdist: + python setup.py sdist --formats=gztar,zip + +egg: + python setup.py bdist_egg + +doc: + epydoc --config epydoc.conf + cp -r docs/html ${TRAC_ROOT}/ + epydoc -v --config epydoc-pdf.conf + cp docs/pdf/api.pdf ${TRAC_ROOT}/ diff --git a/Makefile.distrib b/Makefile.distrib deleted file mode 100644 index 523255b2c2..0000000000 --- a/Makefile.distrib +++ /dev/null @@ -1,8 +0,0 @@ -all: doc tarball - -tarball: - python setup.py sdist --formats=gztar,zip - -doc: - epydoc --config epydoc.conf - epydoc -v --config epydoc-pdf.conf diff --git a/README b/README deleted file mode 100644 index b78423228f..0000000000 --- a/README +++ /dev/null @@ -1,22 +0,0 @@ -Requirements: -1) Python >= 2.5 -2) PyUSB >= 0.3.4 (http://sourceforge.net/projects/pyusb/) -3) For the GUI: - - pyxml >= 0.84 - - PyQt4 >= 4.1 - -Installation: -As root -python setup.py install - -On Linux, to enable access to the reader for non-root users, you need to add the following to -/etc/udev/rules.d/90-local.rules - -BUS=="usb", SYSFS{idProduct}=="029b", SYSFS{idVendor}=="054c", MODE="660", GROUP="plugdev" - -You may have to adjust the GROUP and the location of the 90-local.rules file to suit your distribution. - -Usage: -1) A command line interface is provided via, the command prs500 -2) A GUI is provided via the command prs500-gui -3) You can read/edit the metadata of LRF files via the command lrf-meta diff --git a/epydoc-pdf.conf b/epydoc-pdf.conf index 70769e7013..d0b07f9698 100644 --- a/epydoc-pdf.conf +++ b/epydoc-pdf.conf @@ -2,12 +2,12 @@ # Information about the project. name: libprs500 -#url: http:// +url: http://libprs500.kovidgoyal.net # The list of modules to document. Modules can be named using # dotted names, module filenames, or package directory names. # This option may be repeated. -modules: libprs500, scripts/prs500.py, usb, struct +modules: libprs500/*.py, libprs500.lrf, usb, struct output: pdf target: docs/pdf diff --git a/epydoc.conf b/epydoc.conf index fcad5a2a8d..a898d50add 100644 --- a/epydoc.conf +++ b/epydoc.conf @@ -2,12 +2,12 @@ # Information about the project. name: libprs500 -#url: http:// +url: http://libprs500.kovidgoyal.net # The list of modules to document. Modules can be named using # dotted names, module filenames, or package directory names. # This option may be repeated. -modules: libprs500, scripts/prs500.py, usb, struct +modules: libprs500/*.py, libprs500.lrf, usb, struct # Write html output to the directory "apidocs" output: html diff --git a/prs-500.e4p b/prs-500.e4p index 38f2e97943..a8a809c216 100644 --- a/prs-500.e4p +++ b/prs-500.e4p @@ -1,7 +1,7 @@ - + Python @@ -75,6 +75,15 @@ gui editbook.py + + libprs500 + books.py + + + libprs500 + gui + widgets.py +