Obsolete Air Cooled Documentation Project
Shell Ruby
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
ext
scripts
src
.gitignore
LICENSE
README.md
Rakefile
config.yaml

README.md

OACDP: Obsolete Air Cooled Documentation Project

  1. About
  2. Dependencies
  3. Building
  4. Viewing
  5. Developing
  6. License

About:

The Obsolete Air Cooled Documentation Project is focused on providing access to hard to find, out of print resources for air cooled automobile enthusiasts. This repository is the source for building the site. It uses webgen, which is a ruby utility (I tried staticmatic, but had some wierd issues with it and in the end webgen fit the bill).

Dependencies

Building

First fetch the oacdp source:

mkdir src
cd src
git clone git://github.com/elliottjohnson/oacdp.git oacdp``

Then use webgen to render the site:

cd oacdp
webgen render

Then extract the overlay to install the content:

tar -xvvjpf /the/path/to/your/oacdp-overlay.tar.bz2

Viewing

Use a web browser to open the "oacdp/out/index.html" file. I've used only relative url's within the site to keep things locally viewable.

Deploying

If you wish to deploy from source you can execute the publish.sh script found in the scripts/ directory in the root of your checkout. Make sure you supply a writeable, webviewable directory on your local machine.

scripts/publish.sh /path/to/a/writable/webdir/oacdp      

Developing

I highly recommend setting up a github account, but it's not a requirement. Email if you are interested in commiting.

License

The work being done is under the GNUv3.0 license. See the file LICENSE in the base of this repository for more information.