diff --git a/README.md b/README.md index 6b88193..1019c9f 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,16 @@ Static web page generator for the Hacker Public Radio website. ## Installation * Clone or download this repository * With SQLite - * Create the sqlite3 database from the hpr.sql MySQL dump file available on - hackerpublicradio.org. The default name for the database file is "hpr.db" - and should be located in the root of the project directory. The name and + * Create the sqlite3 database from the hpr.sql MySQL dump file available on + hackerpublicradio.org. The default name for the database file is "hpr.db" + and should be located in the root of the project directory. The name and location can be set in the site.cfg file. - * An "update-hpr.sh" helper script is available in the utils directory. This - script will download the hpr.sql file, convert it to the SQLite hpr.db file, - and regenerate the website using the site-generator. + * An "update-hpr.sh" helper script is available in the utils directory. This + script will download the hpr.sql file, convert it to the SQLite hpr.db file, + and regenerate the website using the site-generator. 1. `cd` into the root of the project directory 2. Run `./utils/update-hpr.sh` - * SQLite v3.8.3 or greater is recommended. CTE WITH clauses are used in some template queries. Must convert WITH + * SQLite v3.8.3 or greater is recommended. CTE WITH clauses are used in some template queries. Must convert WITH clauses to sub-queries when using earlier versions of SQLite. * With MySQL * Create database hpr_hpr in the MySQL server from HPR dump file. @@ -31,18 +31,24 @@ Static web page generator for the Hacker Public Radio website. * Template * Template::Plugin::File * Template::Plugin::DBI + * Template::Plugin::Date + * Template::Plugin::HTML::Strip * DBI * Tie::DBI * DBD::SQLite or DBD:mysql * Date::Calc -* See the Getting Started tutorial (GETTING_STARTED.md) for more details on + * Text::CSV_XS + * HTML::Entities + +* See the [Getting Started](GETTING_STARTED.md) tutorial for more details on installing the HPR generator. + ## Usage Generate two specific pages: -`site-generator index about` +`site-generator index about` Generate the whole site: -`site-generator --all` +`site-generator --all` Generate pages based on the same template: `site-generator correspondent=1,3,5..10` @@ -65,7 +71,7 @@ To make a suggestion, please [submit an Issue](https://repo.anhonesthost.net/rho and add the label "**Feature Request**". ## Authors and acknowledgment -* Roan "Rho`n" Horning +* Roan "Rho`n" Horning * gordons * Ken Fallon -* norrist \ No newline at end of file +* norrist