Skip to content

Commit eb9e19f

Browse files
committed
Reference step-by-step walkthrough in README
1 parent 6df955a commit eb9e19f

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Targeted at hosters of version control platforms (such as [Wikifactory](https://
1818

1919
This *initial* demonstrator is delivered at month 18 of the [OPENNEXT](https://opennext.eu/) project as part of task 2.2: "Creating a design process facilitation dashboard". It is to establish the foundational, "behind the scenes" infrastructure on which the ambition to facilitate company-community collaboration on open source hardware projects described [below](#background) can be pursued. Future iterations of this tool should allow the community developing an open source hardware product to track the health of their project and if their needs are being met. **Importantly, an instance of the data-mining script and dashboard will be hosted by OPENNEXT partner [Wikifactory](https://wikifactory.com/)**. For the purposes of reviewing OPENNEXT deliverables, there is an **[Executive summary](EXECUTIVE_SUMMARY.md)** available.
2020

21-
**Please see the [Install](#install) and [Usage](#usage) sections to get up and running with this tool**. For more details on its background and design considerations, please see the [Background](#background), [Design notes](#design-notes), and [Future work](#future-work) sections.
21+
**Please see the [Install](#install) and [Usage](#usage) sections to get up and running with this tool**. For more details on its background and design considerations, please see the [Background](#background), [Design notes](#design-notes), and [Future work](#future-work) sections. There is also a detailed [step-by-step walkthrough](docs/usage-example.md).
2222

2323
## Table of Contents
2424

@@ -80,7 +80,7 @@ In addition, this repository aims to follow international standards and good pra
8080

8181
## Install
8282

83-
*This section assumes knowledge of Python, Git, and using a GNU/Linux-based server including installing software from package managers and running a terminal session*.
83+
*This section assumes knowledge of Python, Git, and using a GNU/Linux-based server including installing software from package managers and running a terminal session. There is also a detailed [step-by-step walkthrough](docs/usage-example.md)*.
8484

8585
**Note:** This software is designed to be deployed on a server by system administrators or developers, not on generic consumer devices.
8686

@@ -122,7 +122,7 @@ where `[port number]` can be any integer of your choice. The default has been ar
122122

123123
## Usage
124124

125-
*This section assumes basic knowledge of Python and using a terminal session on a GNU/Linux server*.
125+
*This section assumes basic knowledge of Python and using a terminal session on a GNU/Linux server. There is also a detailed [step-by-step walkthrough](docs/usage-example.md)*.
126126

127127
After following the steps in the [Install](#install) section, change directories into `wp2.2_dev` with this terminal command:
128128

0 commit comments

Comments
 (0)