Doc tweaks

dave-redfern · dave-redfern · commit 55af63c78e5d · 2021-03-10T20:00:22.000-05:00
diff --git a/.idea/php.xml b/.idea/php.xml
diff --git a/.idea/project-manager.iml b/.idea/project-manager.iml
diff --git a/docs/changing-config.md b/docs/changing-config.md
@@ -60,9 +60,9 @@ of forcing the one provided via arguments.
 these will be started or stopped together. Use the config options to add or remove these. The
 dependencies are defined as an array in the `project.yaml` on a per service basis.
 
- * [Getting Started](./getting-started.md)
- * [Project Configuration](./project-configuration.md)
- * [Managing Services](./services.md)
- * [Templates](./templates.md)
- * [Changing Config Options](./changing-config.md)
- * [Setting up a dev env](./init-dev-env.md)
+ * [Getting Started](getting-started.md)
+ * [Project Configuration](project-configuration.md)
+ * [Managing Services](services.md)
+ * [Templates](templates.md)
+ * [Changing Config Options](changing-config.md)
+ * [Setting up a dev env](init-dev-env.md)
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -85,9 +85,9 @@ for container names are:
 The import does not try to determine dependencies and will use the folder name as the project
 and dirname values.
 
- * [Getting Started](./getting-started.md)
- * [Project Configuration](./project-configuration.md)
- * [Managing Services](./services.md)
- * [Templates](./templates.md)
- * [Changing Config Options](./changing-config.md)
- * [Setting up a dev env](./init-dev-env.md)
+ * [Getting Started](getting-started.md)
+ * [Project Configuration](project-configuration.md)
+ * [Managing Services](services.md)
+ * [Templates](templates.md)
+ * [Changing Config Options](changing-config.md)
+ * [Setting up a dev env](init-dev-env.md)
diff --git a/docs/init-dev-env.md b/docs/init-dev-env.md
@@ -46,9 +46,9 @@ If debugging is used `-vvv` then each command and it's output will be streamed t
 When developing a setup script, be sure to do it in a virtual machine to avoid damaging your
 own setup.
 
- * [Getting Started](./getting-started.md)
- * [Project Configuration](./project-configuration.md)
- * [Managing Services](./services.md)
- * [Templates](./templates.md)
- * [Changing Config Options](./changing-config.md)
- * [Setting up a dev env](./init-dev-env.md)
+ * [Getting Started](getting-started.md)
+ * [Project Configuration](project-configuration.md)
+ * [Managing Services](services.md)
+ * [Templates](templates.md)
+ * [Changing Config Options](changing-config.md)
+ * [Setting up a dev env](init-dev-env.md)
diff --git a/docs/project-configuration.md b/docs/project-configuration.md
@@ -149,9 +149,9 @@ per-project basis in the templates section.
 
 See [templates](./templates.md) for more information.
 
- * [Getting Started](./getting-started.md)
- * [Project Configuration](./project-configuration.md)
- * [Managing Services](./services.md)
- * [Templates](./templates.md)
- * [Changing Config Options](./changing-config.md)
- * [Setting up a dev env](./init-dev-env.md)
+ * [Getting Started](getting-started.md)
+ * [Project Configuration](project-configuration.md)
+ * [Managing Services](services.md)
+ * [Templates](templates.md)
+ * [Changing Config Options](changing-config.md)
+ * [Setting up a dev env](init-dev-env.md)
diff --git a/docs/services.md b/docs/services.md
@@ -193,9 +193,9 @@ __Note:__ the network name and project name are automatically resolved using the
 configuration from the project file. If a mis-match is detected, you will be notified of the
 issue.
 
- * [Getting Started](./getting-started.md)
- * [Project Configuration](./project-configuration.md)
- * [Managing Services](./services.md)
- * [Templates](./templates.md)
- * [Changing Config Options](./changing-config.md)
- * [Setting up a dev env](./init-dev-env.md)
+ * [Getting Started](getting-started.md)
+ * [Project Configuration](project-configuration.md)
+ * [Managing Services](services.md)
+ * [Templates](templates.md)
+ * [Changing Config Options](changing-config.md)
+ * [Setting up a dev env](init-dev-env.md)
diff --git a/readme.md b/readme.md
@@ -10,15 +10,18 @@ and continue on. There is no special configuration needed in any project.
 
 ## Features
 
- * groups separate micro services projects together
- * gives a docker overview of running processes
+ * groups separate micro-service projects together
+ * gives an overview of running docker processes across all services
  * supports dependencies between services
- * supports making new services and libraries (configurable source repositories)
  * supports multiple projects on a single machine
+ * supports templates for libraries and services
+ * supports docker container definitions for easier adding to services
  * all configuration is by yaml files
 
 ## Installation
 
+Project Manager requires PHP 7.3+ to be installed and in your shell path.
+
 Grab the phar archive and copy it to `/usr/local/bin` or add it to your path.
 Symlink the phar to `spm` or a.n.other name. Be sure to verify the SHA checksum with
 the ones in the release checksums text file.
@@ -29,15 +32,15 @@ Or:
 
 Run: `spm init` to create the standard configuration (see later).
 
-See [getting started](./docs/getting-started.md) for the next steps.
+See [getting started](docs/getting-started.md) for the next steps.
 
 More:
 
- * [Project Configuration](./docs/project-configuration.md)
- * [Managing Services](./docs/services.md)
- * [Templates](./docs/templates.md)
- * [Changing Config Options](./docs/changing-config.md)
- * [Setting up a dev env](./docs/init-dev-env.md)
+ * [Project Configuration](docs/project-configuration.md)
+ * [Managing Services](docs/services.md)
+ * [Templates](docs/templates.md)
+ * [Changing Config Options](docs/changing-config.md)
+ * [Setting up a dev env](docs/init-dev-env.md)
 
 ### Removing Project Manager
 
