Commit cc8c0d49 authored by Micha Müller's avatar Micha Müller
Browse files

Update READMEs

parent 9c1a3004
......@@ -17,6 +17,7 @@ Other features included by DCDB:
Prerequisites:
* cmake
* C++11 compiler
* Doxygen (to build documentation)
```bash
//Create a new directory for DCDB
......@@ -72,4 +73,4 @@ See the `LICENSE` file for more information.
-develop for framework itself
-dig deeper into doxygen to get a beatiful documentation. perhaps use
markdown files for pages (for tutorials, architecture explanation)
-->
\ No newline at end of file
-->
......@@ -21,7 +21,6 @@
1. [counterData](#opaCounterData)
8. [ProcFS](#procfs)
9. [Writing own plugins](#writingOwnPlugins)
3. [TODOS](#todos)
## Introduction <a name="introduction"></a>
DCDB (DataCenter DataBase) is a database to collect various (sensor-)values of a datacenter for further analysis.
......@@ -667,10 +666,7 @@ Additional CPU-related metrics (that may be introduced in future versions of the
Note that for /proc/meminfo instances, an additional synthetic sensor of type "MemUsed" can be defined. This sensor will automatically extract the amount of used memory from the MemTotal and MemFree values present in meminfo files.
## Writing own plugins <a name="writingOwnPlugins"></a>
First make sure you read the [plugins](#plugins) section.
Try out the `pluginGenerator/generatePlugin.sh` script!
TODO!
First make sure you read the [plugins](#plugins) section.
It is recommended to use the `pluginGenerator/generatePlugin.sh` script to kick off plugin development. Running `./generatePlugin.sh -h` gives instructions on how to use the script. On success, the script generates all required source files for a new plugin with instructions on how to continue from there.
#### TODOS <a name="todos"></a>
* explain special cases in the code for every plugin?
* more about mqtt-topic
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment