diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..34b02ab7abb93fc108cebaf29e0f8af1d59a0aca --- /dev/null +++ b/LICENSE @@ -0,0 +1,24 @@ +Copyright (c) 2020, Technische Universität Dresden, Germany +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, are permitted +provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list of conditions + and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions + and the following disclaimer in the documentation and/or other materials provided with the + distribution. + +3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse + or promote products derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR +IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR +CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER +IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF +THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/readme.md b/readme.md index a410857059c7a37120a874e70a4ba377862c9e07..a71b760ab8ff3c64ab193f9b6e52a7ca4fb04bd8 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,3 @@ - # Collectl2plotly Collectl2plotly is a python commandline tool, to build htmlsites with plotly diagrams from data that was collected with [collectl](http://collectl.sourceforge.net). @@ -54,9 +53,8 @@ Merging means that all values from "collectl" will be accumulated (using a mergi Note: -Filtering is not done in the config you filter in the [options](#options) of the command. - -Filtering means sort out commands that are not relevant enough to be displayed in the diagrams to keep the diagramm clean. +Filtering is not set in the config you filter with the [options](#options) of the command. +With filtering is mean sort out commands that are not relevant enough to be displayed in the diagrams to keep the diagramm clean. #### NEEDED_VALUES Specifies which values are merged under which names in a dict. @@ -285,7 +283,7 @@ A filter function must return a dict, structured like this: ``` ## Merger -A merger is a function that merge values from collectl to existing values or the base value this is set in the config see [here](NEEDED_VALUES). +A merger is a function that merge values from collectl to a existing value or a base value what is set in the config see [here](NEEDED_VALUES). It is also used to format and convert the values from collectl.