ADC Archives online browser
Ruby JavaScript
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
config
db
doc
lib
log
public
script
spec
tmp
vendor/plugins
.gitignore
.gitmodules
Capfile
README
README.rails
Rakefile

README

== Welcome to the ADC Archives Application

This project is an attempt to provide a web interface to an extensive set of 
scanned documents forming the archives of the ADC Theatre, Cambridge.

== Development

The project is a rails application and thus depends on ruby (>=1.8.5) and
rails (2.3.3). To get started developing, you'll probably want to run the 
following commands.

    # if you haven't already, install ruby and rubygems (use google), then
    # run
    sudo gem install rails -v2.3.3

    # download the submodules (mostly rails plugins)
    git submodule update --init

    rake setup

    # optionally, configure the databases you wish to use for development and 
    # testing
    vim config/database.yml 

    # the next command may require root privileges
    sudo rake gems:install 

    # set up the database and run the tests (they should all pass!)
    rake db:migrate
    rake

    # start the app
    ./script/server

Now, if all went well, you should be able to visit http://localhost:3000/ and 
see the front page of the application.

== License

ADC Archives -- A web interface to the archives of the ADC Theatre, Cambridge.
Copyright (C) 2008, Nick Stenning et al.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.