Initial version of "ppq" - portable PostgreSQL

This allows running PostgreSQL locally without having to set up a
system-wide service.  It is portable in the sense that you can move
the directory around, and you can run multiple instances side-by-side.

1 files changed, 22 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..a4aa7c0
--- /dev/null
+++ b/README
@@ -0,0 +1,22 @@
+ppq - Portable PostgreSQL
+=========================
+
+This allows running PostgreSQL locally without having to set up a
+system-wide service. It is portable in the sense that you can move the
+directory around, and you can run multiple instances side-by-side.
+
+It serves as a good basis to use as a development environment, for
+projects that require a Postgres server.
+
+How to use
+----------
+
+The best way to run this project is with Nix and direnv.  You don't
+need NixOS.
+
+Simply cd into the directory, and direnv should take care of the rest.
+Then you can run a Postgres server with `./ppq start`.
+
+All Postgres client programs (like `psql`, `pg_restore` etc) are
+available and environment variables like `PGUSER` and `PGHOST` are set
+up to ensure it will talk to the local Postgres server automatically.
\ No newline at end of file