diff options
Diffstat (limited to 'README.pod')
-rw-r--r-- | README.pod | 76 |
1 files changed, 0 insertions, 76 deletions
diff --git a/README.pod b/README.pod deleted file mode 100644 index 6b4494f38..000000000 --- a/README.pod +++ /dev/null @@ -1,76 +0,0 @@ -=head1 Welcome to FixMyStreet - -FixMyStreet is an open source project to develop a website for reporting -problems such as potholes and broken street lights to the appropriate authority. - -Users locate problems using a combination of address and sticking a pin -in a map without worrying about the correct authority to report it to. -FixMyStreet then works out the correct authority to report it to using -the problem location and type and sends a report. - -It was created in 2007 by L<mySociety|http://www.mysociety.org> for reporting problems to UK councils and -has been copied around the world. - -We're working hard to make it easy to install and re-use in other -countries and welcome questions about how it works on our mailing list: -L<https://secure.mysociety.org/admin/lists/mailman/listinfo/fixmystreet>. - -We've also got a new site and blog which over time will become a useful -resource for people interested in installing or developing FixMyStreet -at L<http://code.fixmystreet.com/>. - -FixMyStreet is written in Perl and uses the Catalyst web framework. - -=head1 EXAMPLES - -L<http://www.fixmystreet.com> - -L<http://www.fiksgatami.no/> - -=head1 QUICKSTART - -If you're reasonably sure what you are doing then you can follow the -quickstart instructions. Otherwise there are more detailed instructions -in C<notes/INSTALL.pod> - -=over - -=item * - -Fetch the latest version from L<Github|https://github.com/mysociety/fixmystreet/> - -=item * - -Create a new PostGIS enabled database - -=item * - -Create the database using C<db/schema.sql> and the C<db/alert_types.sql> - -=item * - -Run C<./bin/install_perl_modules> to install the required Perl modules. - -=item * - -Create a new Apache vhost based on C<conf/httpd-conf.example> - -=item * - -Copy C<conf/general.yml-example> to C<conf/general.yml> and update -the defaults accordingly. - -=item * - -Generate the CSS by running C<bin/make_css> - -=item * - -Restart the webserver - -=item * - -Edit the crontab from C<conf/crontab> to replace the placeholders and -install it. See C<notes/INSTALL.pod> for more details on the placeholders. - -=back |