Skip to content

Commit 8672cc5

Browse files
authored
Update README.md
1 parent 252c3bb commit 8672cc5

1 file changed

Lines changed: 10 additions & 3 deletions

File tree

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1+
## Requirements
2+
3+
A CC7 machine or a mac.
4+
15
## Setup
26

3-
Install devtoolset-6:
7+
On CC7, install devtoolset-6:
48

59
```
610
yum install centos-release-scl
@@ -40,7 +44,7 @@ sudo systemctl start mariadb
4044
qcDatabaseSetup.sh
4145
```
4246

43-
## QC Configuration
47+
## Configuration
4448

4549
The QC requires a number of configuration items. An example config file is
4650
provided in the repo under the name _example-default.ini_. Moreover, the
@@ -115,7 +119,7 @@ tasksAddresses=tcp://localhost:5556,tcp://localhost:5557,tcp://localhost:5558,tc
115119
There are configuration items for many other aspects, for example the
116120
database connection, the monitoring or the data sampling.
117121

118-
## Execution
122+
## Usage
119123

120124
### Basic
121125
With the default config files provided, we run a qctask that processes
@@ -182,3 +186,6 @@ is 5600.
182186
One can also check what is stored in the database by clicking `Stop`
183187
and then switching to `Database` source. This will only work if a config
184188
file was passed to the `qcSpy` utility.
189+
190+
## Documentation todo
191+
- a step by step to develop a new module

0 commit comments

Comments
 (0)