forked from rho_n/hpr_generator
41 lines
1.6 KiB
Markdown
41 lines
1.6 KiB
Markdown
# hpr_generator
|
|
Static web page generator for the Hacker Public Radio website.
|
|
|
|
## Installation
|
|
* Clone or download this repository
|
|
* Create the sqlite3 database from the files in the _sql directory. 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.
|
|
* Install the needed Perl modules using preferred method (distribution packages, CPAN, etc.)
|
|
* GetOpt
|
|
* Pod::Usage
|
|
* Config::Std
|
|
* Template
|
|
* DBI
|
|
|
|
## Usage
|
|
Generate two specific pages:
|
|
`site-generator index about`
|
|
|
|
Generate the whole site:
|
|
`site-generator ALL`
|
|
|
|
## Support
|
|
Please [submit an Issue](https://gitlab.com/roan.horning/hpr_generator/-/issues),
|
|
and add the label "**Help Request**" for help running or installing the site-generator.
|
|
|
|
For discussing HPR site generation in general, please [submit an Issue](https://gitlab.com/roan.horning/hpr_generator/-/issues) and add the label "**General Discussion**".
|
|
|
|
## Contributing
|
|
Happy to take any contributions or suggestions.
|
|
|
|
To contribute code or documentation, please create a fork of the project and [submit a merge request](https://gitlab.com/roan.horning/hpr_generator/-/merge_requests) or send a patch.
|
|
|
|
If you have found an error in the code or the generated HTML, please [submit an Issue](https://gitlab.com/roan.horning/hpr_generator/-/issues),
|
|
and add the label "**Bug Found**".
|
|
|
|
To make a suggestion, please [submit an Issue](https://gitlab.com/roan.horning/hpr_generator/-/issues),
|
|
and add the label "**Feature Request**".
|
|
|
|
## Authors and acknowledgment
|
|
* Roan "Rho`n" Horning
|
|
|