update README files

openkfw · Apr 2, 2019 · 9b75860 · 9b75860
1 parent 843dac1
commit 9b75860
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -21,12 +21,12 @@ TruBudget - a trusted public expenditure tool. A collaborative workflow tool and
 
 These instructions will get you a copy of the project up and running on your local machine.
 
->_Caution_: This guide works well wil Linux and OS X operating systems. For Windows, we recommend using the Git Bash (or something similar) to perform the commands listed below, but there could still be issues while performing some of the commands.
+>_Caution_: This guide is tested against Linux and OS X operating systems. For Windows, we recommend using the Git Bash (or something similar) to perform the commands listed below, but there could still be issues while performing some of the commands.
 
 ## Prerequisites
 
 - [Docker](https://www.docker.com/) (Version 17.03.0+)
-- [Docker-Compose](https://docs.docker.com/compose/) (Version 3+)
+- [Docker-Compose](https://docs.docker.com/compose/)
 
 ## Installing
 
@@ -54,7 +54,7 @@ This will start a prod and test instance of TruBudget (blockchain, api, frontend
 > Caution: The process of provisioning may take several minutes (depending on your CPU) and can slow down your computer during the execution of the script.
 
 If you want to start with an empty blockchain (i.e. without any users but `root` and without any projects), you can run:
-```
+```bash
 sh scripts/master/start-master-node.sh
 ```
 
@@ -92,7 +92,7 @@ The blockchain data is persisted on your hard drive. The standard location on Li
 
 # Build and Develop from Local Sources
 
-Checkout the [Contributor Guide](https://github.com/openkfw/TruBudget/blob/master/doc/wiki/Contributor-Guide/Contributor-Guide.md) to learn how to set up your environment to start developing and debugging the TruBudget application.
+Checkout the [Contributor Guide](./doc/wiki/Contributor-Guide/Contributor-Guide.md) to learn how to set up your environment to start developing and debugging the TruBudget application.
 
 <!-- # Troubleshooting
 TBD -->

diff --git a/doc/README.md b/doc/README.md
@@ -33,15 +33,15 @@ For more information about what an ADR is visit the [architecture_decision_recor
 
 Following table shows a list of TruBudget's ADRs:
 
-| Title                                          | Link                                                                                   |
-| :--------------------------------------------- | :------------------------------------------------------------------------------------- |
-| Record Architecture Decisions (ADRs)           | [0001-record-architecture-decisions.md](adr/0001-record-architecture-decisions.md)     |
-| Access Control Model/Authorization             | [0002-access-control-model.md](adr/0002-access-control-model.md)                       |
-| Project Data Model                             | [0003-project-data-model.md ](adr/0003-project-data-model.md)                          |
-| Resource (e.g.,Project,Subproject) Lifetime    | [0004-ressource-level-lifetime.md](adr/0004-ressource-level-lifetime.md)               |
-| Workflowitem Ordering                          | [0005-workflowitem-ordering.md](adr/0005-workflowitem-ordering.md)                     |
-| Multi Node Setup (Superceded)                  | [0006-multi-node-setup.md](adr/0006-multi-node-setup.md)                               |
-| Basic Execution Architecture                   | [0007-execution-architecture-overview.md](adr/0007-execution-architecture-overview.md) |
-| Git Branching/Releasing Model                  | [0008-git-branching-model.md](adr/0008-git-branching-model.md)                         |
-| Multichain Migration Model                     | [0009-migration-model.md](adr/0009-migration-model.md)                                 |
-| Multi Node Setup/ Address Private Key Handling | [0010-multi-node-setup.md](adr/0010-multi-node-setup.md)                               |
+| Title                                         | Link                                                                                   |
+| :-------------------------------------------- | :------------------------------------------------------------------------------------- |
+| Record Architecture Decisions (ADRs)          | [0001-record-architecture-decisions.md](adr/0001-record-architecture-decisions.md)     |
+| Access Control Model/Authorization            | [0002-access-control-model.md](adr/0002-access-control-model.md)                       |
+| Project Data Model                            | [0003-project-data-model.md ](adr/0003-project-data-model.md)                          |
+| Resource (e.g.,Project,Subproject) Lifetime   | [0004-ressource-level-lifetime.md](adr/0004-ressource-level-lifetime.md)               |
+| Workflowitem Ordering                         | [0005-workflowitem-ordering.md](adr/0005-workflowitem-ordering.md)                     |
+| Multi Node Setup (Superceded)                 | [0006-multi-node-setup.md](adr/0006-multi-node-setup.md)                               |
+| Basic Execution Architecture                  | [0007-execution-architecture-overview.md](adr/0007-execution-architecture-overview.md) |
+| Git Branching/Releasing Model                 | [0008-git-branching-model.md](adr/0008-git-branching-model.md)                         |
+| Multichain Migration Model                    | [0009-migration-model.md](adr/0009-migration-model.md)                                 |
+| Multi Node Setup/Address Private Key Handling | [0010-multi-node-setup.md](adr/0010-multi-node-setup.md)                               |