diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..25c5174 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,50 @@ +# Installing pgloader + +pgloader version 3.x is written in Common Lisp. + +## The lisp parts + +The steps depend on the OS you are currently using. + +### debian + +If you're using debian, it's quite simple actually, see the file +`bootstrap-debian.sh` within the main pgloader distribution to get yourself +started. + +You will note in particular: + + sudo apt-get install -y sbcl \ + git patch unzip \ + devscripts pandoc \ + libsqlite3-dev + +We need a recent enough [SBCL](http://sbcl.org/) version and that means +backporting the one found in `sid` rather than using the very old one found +in current *stable* debian release. See `bootstrap-debian.sh` for details +about how to backport a recent enough SBCL here (1.1.14 or newer). + +### Mac OS X + +We suppose you already have `git` and `make` available, if that's not the +case now is the time to install those tools. The SQLite lib that comes in +MacOSX is fine, no need for extra software here. + +## Building the pginstall tool + +Now that the dependences are installed, just type make. + + make + +If using Mac OS X, and depending on how you did install `SBCL` and which +version you have (the brew default did change recently), you might need to +ask the Makefile to refrain from trying to compress your binary image: + + make COMPRESS_CORE=no + +Then you will have a new tool to play with: + + ./build/bin/pgloader --help + +This command should spit out the *usage* information on which parameters are +accepted in the command line actually. diff --git a/README.md b/README.md index 52d074e..87dea84 100644 --- a/README.md +++ b/README.md @@ -36,12 +36,10 @@ pgloader is now a Common Lisp program, tested using the [SBCL](http://sbcl.org/) (>= 1.1.14) implementation with [Quicklisp](http://www.quicklisp.org/beta/). - $ apt-get install sbcl libsqlite3-dev make curl + $ apt-get install sbcl libsqlite3-dev make curl $ cd /path/to/pgloader - $ mkdir -p ~/.config/common-lisp/source-registry.conf.d - $ echo "(:tree `pwd`)" > ~/.config/common-lisp/source-registry.conf.d/pgloader.conf $ make pgloader - $ ./build/pgloader.exe --help + $ ./build/bin/pgloader --help ### Patches