summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAustin <austi_gillm935@ahapps.anoka.k12.mn.us>2016-06-29 03:57:26 +0200
committerGitHub <noreply@github.com>2016-06-29 03:57:26 +0200
commit2e2708c050e7fd3de7fe2008c6ddf5e0d03454fd (patch)
tree850a5f0badca292ffcdf3c791859fe739f9c5b22 /README.md
parent54c0ea7c9cc26f42196f50fd9f5ce2027840fae0 (diff)
Reword cloning steps
Users that skim thru the readme will just copy paste the first commands they see without reading, they shouldn't be hosted a clone, but should still be catered to in some case. This is just simply flipping the commands around.
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index 6204981..81252d7 100644
--- a/README.md
+++ b/README.md
@@ -40,15 +40,15 @@ Node, or NPM. So we'll just assume you already have them all running well.
### Compiling
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
+You will need to recursively clone the repo to get the required PHP submodule,
+and the optional user panel submodule.
```bash
-git clone https://github.com/pomf/pomf
+git clone --recursive https://github.com/pomf/pomf
```
-else, run
+If you don't want either of the submodules run the following command,
```bash
-git clone --recursive https://github.com/pomf/pomf
+git clone 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.