== Welcome to 3accounts

3accounts is a set of web pages and software components that allows you
to comply with your businesses tax and reporting requirements.

Currently the software focusses on small UK Limited Companies.

The software is written in Ruby on Rails and tested using the Rspec BDD
system and deployed with Capistrano directly from the Git repository.

The main website is http://www.3accounts.co.uk where you can find pointers
on how to help contribute and improve this software.

3accounts is free software published under the Gnu Affero GPL. See
LICENSE for more details.

== Description of Contents

app
  Holds all the code that's specific to this particular application.

app/controllers
  Holds controllers that should be named like weblogs_controller.rb
  for automated URL mapping. All controllers should descend from
  ApplicationController which itself descends from ActionController::Base.

app/models
  Holds models that should be named like post.rb.
  Most models will descend from ActiveRecord::Base.

app/views
  Holds the template files for the view that should be named like
  weblogs/index.erb for the WeblogsController#index action. All views
  use eRuby syntax.

app/views/layouts
  Holds the template files for layouts to be used with views. This models
  the common header/footer method of wrapping views. In your views,
  define a layout using the <tt>layout :default</tt> and create a file
  named default.erb. Inside default.erb, call <% yield %> to render the
  view using this layout.

app/helpers
  Holds view helpers that should be named like weblogs_helper.rb. These
  are generated for you automatically when using script/generate for
  controllers. Helpers can be used to wrap functionality for your views
  into methods.

config
  Configuration files for the Rails environment, the routing map, the
  database, and other dependencies.

db
  Contains the database schema in schema.rb.  db/migrate contains all
  the sequence of Migrations for your schema.

doc
  This directory is where your application documentation will be stored
  when generated using <tt>rake doc:app</tt>

lib
  Application specific libraries. Basically, any kind of custom code that
  doesn't belong under controllers, models, or helpers. This directory
  is in the load path.

public
  The directory available for the web server. Contains subdirectories for
  images, stylesheets, and javascripts. Also contains the dispatchers
  and the default HTML files. This should be set as the DOCUMENT_ROOT
  of your web server.

script
  Helper scripts for automation and generation.

test
  Unit and functional tests along with fixtures. When using the
  script/generate scripts, template test files will be generated for
  you and placed in this directory.

vendor
  External libraries that the application depends on. Also includes the
  plugins subdirectory.  This directory is in the load path.

== LICENSE CONTACT
    Copyright (C) 2008, Neil Wilson <aldursys@gmail.com>, Aldur Systems
    Portions Crown Copyright.

    This file is part of 3accounts

    3accounts 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/>.

== ACKNOWLEDGEMENTS
    This software stands on a mountain of open source and freely available code
    particularly the Rails framework. All non-original files have their
    original copyright intact.