This repository is private.
All pages are served over SSL and all pushing and pulling is done over SSH.
No one may fork, clone, or view it unless they are added as a member.
Every repository with this icon (
) is private.
Every repository with this icon (
This repository is public.
Anyone may fork, clone, or view it.
Every repository with this icon (
) is public.
Every repository with this icon (
| name | age | message | |
|---|---|---|---|
| |
.gitattributes | Tue Nov 25 15:21:08 -0800 2008 | |
| |
.gitignore | Thu Feb 26 03:32:45 -0800 2009 | |
| |
LICENSE | Thu Feb 19 16:43:20 -0800 2009 | |
| |
LICENSE.doc | Thu Feb 19 16:43:20 -0800 2009 | |
| |
LICENSE.jquery | Thu Feb 19 16:43:20 -0800 2009 | |
| |
LICENSE.src | Thu Feb 19 16:43:20 -0800 2009 | |
| |
Makefile.am | Sat Mar 14 17:33:00 -0700 2009 | |
| |
README | Mon Mar 23 13:08:05 -0700 2009 | |
| |
configure.ac | Sat Mar 14 10:55:52 -0700 2009 | |
| |
src/ | Mon Mar 23 11:41:51 -0700 2009 |
README
Short Version
=============
Assuming you have the dependencies:
# aclocal ; automake ; autoconf ; ./configure ; make ; sudo make install
Will build all docs that it can. Installs PDFs and HTML docs in:
${prefix}/doc/vertebra
Long Version
============
The autoconf system currently creates a vertebra.pdf document that describes
the overall design of Vertebra. This document is built using TeX and a few
support utilities for the figures (most notably GraphViz). OmniGraffle source
is included for some manually produced figures. This manual is not yet
considered comprehensive, nor complete, nor final. The beginnings of work to
generate HTML documentation are also present.
MacOS X
-------
To build the docs on MacOS, use MacPorts. Almost everything I needed was
there. Try the following packages (note the variants!):
* texlive_base +no_x11 (X11 never seems to build for me)
* texlive +letter (to set the system page size to US Letter)
* graphviz +no_x11 (for figures)
You'll also need python with lxml. Depending on the state of your system, you
can use the command "sudo easy_install lxml". If that doesn't work, you may
need to install setuptools, which is available here:
* http://peak.telecommunity.com/DevCenter/setuptools
Linux
-----
To build the docs on Linux, you will need some packages. So far, I've tried
with Debian lenny. I needed the following packages and their dependencies:
* texlive-latex-recommended (for pdflatex and other basics)
* texlive-latex-extra (for nomencl.sty)
* texlive-latex-fonts-recommended (for pzdr font used by hyperref.sty)
* ghostscript (for ps2pdf, since graphviz doesn't support PDF here)
* python-lxml (for HTML documentation)







