Archived
4
2

Compare commits

...

2 Commits

Author SHA1 Message Date
fc7975379e
Fix grammer issues 2023-03-09 21:42:36 -05:00
207eabec86
Add reference to the file GETTING_STARTED.md
Update the Installation instructions to include reference
to the Getting Started tutorial.
2023-03-09 21:39:53 -05:00
2 changed files with 7 additions and 5 deletions

View File

@ -3,7 +3,8 @@
If git is not installed on the operating system, please install it now
(see the git documentation for [instructions on installing git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)).
To retrieve the code from the repository on anhonesthost.net, run:
To retrieve the code from the repository on anhonesthost.net (a username and
password are required), run:
`git clone https://repo.anhonesthost.net/rho_n/hpr_generator.git`
@ -17,7 +18,7 @@ which the clone command was executed containing a local copy of the git reposito
# Install required Perl modules
Installing the Perl modules is the most finicky part of the installation process.
The needed Perl modules can be found using the operating systems's package
The needed Perl modules can be found using the operating system's package
manager or using the modules found in the
[Comprehensive Perl Archive Network (CPAN)](https://www.cpan.org/).
@ -35,7 +36,7 @@ apt install libconfig-std-perl \
## Using CPAN to install the modules
A cross platform method to install the needed modules is Perl CPAN application.
A cross platform method to install the needed modules is the Perl CPAN application.
Make sure both the [make](https://www.gnu.org/software/make/manual/make.html)
command and the [cpan](https://perldoc.perl.org/CPAN) command are available.
Install them using the operating system's package manager, or from source.
@ -56,7 +57,7 @@ cpan Tie::DBI
The hpr_generator relies on information from a database to generate many of the
files for the website (for example: index.html, series/index.html,
hpr_mp3.rss, etc). This data is available from a MySQL dump file found on
hackerpublicradio.org at "https://www.hackerpublicradio.org/hpr.sql".
hackerpublicradio.org at URL "https://www.hackerpublicradio.org/hpr.sql".
The first step is to download the hpr.sql file. This can be done using your
browser, or by running one of the following commands:

View File

@ -35,7 +35,8 @@ Static web page generator for the Hacker Public Radio website.
* Tie::DBI
* DBD::SQLite or DBD:mysql
* Date::Calc
* See the Getting Started tutorial (GETTING_STARTED.md) for more details on
installing the HPR generator.
## Usage
Generate two specific pages:
`site-generator index about`