From 8906b605e65530d7f6f48e0dbb41de1b6af0fc55 Mon Sep 17 00:00:00 2001 From: Jeff Scheel Date: Wed, 17 Feb 2016 10:01:30 -0600 Subject: [PATCH] Update README.md - Corrected formatting of nested code in bulleted list. - Corrected wording to explicitly reference Docs-Template project --- README.md | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 6830fa7..2d1f644 100644 --- a/README.md +++ b/README.md @@ -8,19 +8,23 @@ To build this project, one must ensure that the Docs-Master project has also been cloned at the same directory level as the Docs-Template project. This can be accomplished with the following steps: -1. Clone this project (Docs-Master) using the following command: -``` -$ git clone https://github.com/OpenPOWERFoundation/Docs-Master.git -``` -2. Clone the documentation project (my_project) using the following command: -``` -$ git clone https://github.com/OpenPOWERFoundation/my_project.git -``` +1. Clone the master documentation project (Docs-Master) using the following command: + + ``` + $ git clone https://github.com/OpenPOWERFoundation/Docs-Master.git + ``` + +2. Clone this project (Docs-Template) using the following command: + + ``` + $ git clone https://github.com/OpenPOWERFoundation/Docs-Template.git + ``` + 3. Build the project with these commands: -``` -$ cd Docs-Template -$ mvn clean generate-sources -``` + ``` + $ cd Docs-Template + $ mvn clean generate-sources + ``` The online version of the document can be found in the OpenPOWER Foundation Document library at [TBD](http://openpowerfoundation.org/docs)