From 4e16303887a65cf010983afa784036549362d254 Mon Sep 17 00:00:00 2001 From: ileyd Date: Wed, 29 Jun 2016 03:38:08 +1000 Subject: Explains how to compile submodules --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0b7d9a3..6204981 100644 --- a/README.md +++ b/README.md @@ -39,12 +39,27 @@ Node, or NPM. So we'll just assume you already have them all running well. ### Compiling -Assuming you already have Node and NPM working, compilation is easy. Use the -following shell code: +First you must get a copy of the pomf code. To do so, clone this git repo. +If you have no desire for any submodules, which includes the PHP backend, simply run +```bash +git clone https://github.com/pomf/pomf +``` +else, run ```bash git clone --recursive https://github.com/pomf/pomf +``` +to automatically fetch all of the submodules as well + +Assuming you already have Node and NPM working, compilation is easy. If you would like any additional submodules, or to exclude the default PHP submodule, use the `MODULES="..."` variable. + +Run the following commands to do so. +```bash cd pomf/ make +# alternatively +make MODULES="" # compile no submodules; exclude the default php backend module +make MODULES="php moe" # compile the php and moe submodules +# make install ``` OR -- cgit v1.2.3