add install notes

michaele-blend · Oct 3, 2021 · da5f18d · da5f18d
1 parent d1ca3a9
commit da5f18d
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/Changes b/Changes
@@ -2,6 +2,7 @@
 
   - Fix -p short option (thanks to Jacek Trociński @jacektrocinski)
   - Improve Docker workflow (thanks to Olivier Daland @olivierdalang)
+  - Added INSTALL.md (thanks Nathan Dawson @Fedelaus)
 
 1.12 Sep 21, 2021
 

diff --git a/README.md b/README.md
@@ -30,6 +30,21 @@ PostgreSQL database named "mydb", a sample database could be constructed with:
 - pg\_dump should be in your search path (in order to dump the schema)
 - Perl DBI and DBD::Pg (>= 2.0) modules
 
+## Installation
+
+1. Clone repo. e.g.,
+
+   $ git clone git@github.com:mla/pg_sample.git
+
+2. Install dependencies. For Ubuntu / Mint, try:
+
+   $ sudo apt install perl libdbi-perl libdbd-pg-perl
+
+3. Run it.
+
+   $ cd pg_sample
+   $ ./pg_sample [OPTIONS] ... # See below for options
+
 ## Command-line Options
 
 _dbname_