Merge pull request #487 from rolsonquadras/readme-update

docs: Move build instruction to build.md from README.md
trustbloc · Aug 31, 2020 · 9ddc435 · 9ddc435
2 parents 77bfe47 + f1d167a
commit 9ddc435
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -6,25 +6,6 @@
 [![codecov](https://codecov.io/gh/trustbloc/edge-service/branch/master/graph/badge.svg)](https://codecov.io/gh/trustbloc/edge-service)
 [![Go Report Card](https://goreportcard.com/badge/github.com/trustbloc/edge-service)](https://goreportcard.com/report/github.com/trustbloc/edge-service)
 
-## Prerequisites (for running tests and demos)
-- Go 1.13
-- Docker
-- Docker-Compose
-- Make
-
-## Targets
-```
-# run checks and unit tests
-make all
-# run linter checks
-make checks
-# run unit tests
-make unit-test
-```
-
-## Build
-To build from source see [here](docs/build.md).
-
 # edge-service
 
 Edge Service is a reference implementation that demonstrates the following story:
@@ -38,6 +19,9 @@ operations:
 - Retrieve verifiable credential from [EDV](https://github.com/trustbloc/edv)
 - Verify verifiable credential 
 
+## Build
+To build from source see [here](docs/build.md).
+
 # Documentation
 - [VC REST APIs](docs/vc-rest/api_overview.md)
 - [OpenAPI Spec](docs/vc-rest/openapi_spec.md)

diff --git a/docs/build.md b/docs/build.md
@@ -12,11 +12,22 @@
 
 ## Targets
 
-    # run checks and unit tests
-    make all
+```
+# run checks and unit tests
+make all
+
+# run linter checks
+make checks
+
+# run unit tests
+make unit-test
+
+# run checks and unit tests
+make all
     
-    # run BDD tests
-    make bdd-test
+# run BDD tests
+make bdd-test
+```
 
 ## BDD Test Prerequisites