~carstengrohmann/OOMAnalyser

c5698c304d2347c66a88a868a9a5a22560f737c0 — Carsten Grohmann 2 years ago 0d0fe27
Update documenation
2 files changed, 17 insertions(+), 19 deletions(-)

M OOMAnalyser.html
M README.md
M OOMAnalyser.html => OOMAnalyser.html +10 -11
@@ 6,7 6,7 @@
    <title>OOM Analyser</title>

    <style>
        /* Use BEM naming convention */
        /* Use BEM (Block__Element--Modifier) naming convention */

        .text--append-suffix-kbytes {
            text-align: right;


@@ 640,29 640,28 @@ function goBack() {
</div>

<div class="js-text--default-hide js-text--display-none" id="changelog">
    <h3>Version 0.3.0 - 2019-XX-XX:</h3>
    <h3>Version 0.3.0 - 2019-11-24:</h3>

    <h4>General</h4>
    <ol>
        <li>Improve presentation</li>
        <li>Separate analysis and visualisation code</li>
        <li>Use CSS classes to control the visibility</li>
        <li>Strip columns left to the message automatically</li>
        <li>Lot if internal improvements and restructuring</li>
        <li>Bug fixes</li>
    </ol>

<!--
    <h4>Known issues</h4>
    <ol>
        <li>none</li>
    </ol>

-->
    <h4>Note</h4>
    <ol>
        <li>
            See the
            <a href="https://github.com/CarstenGrohmann/OOMAnalyser/commits" title="commit history">commit history</a>
            of the repository for a full list of changes.
        </li>
    </ol>
    See the
    <a href="https://github.com/CarstenGrohmann/OOMAnalyser/compare/v0.2.0...v0.3.0"
       title="commit history">commit history</a>
    of the repository for a full list of changes.
</div>

<div>

M README.md => README.md +7 -8
@@ 2,17 2,16 @@

## Introduction

OOMAnalyser is a small project to transform the OOM output of a Linux kernel
into a more human friendly format and show the information on a single web
page. All data will be processed locally in your browser - the data will not
transferred to foreign servers. Thereby the OOM webpage can be used without an
Internet connection also.
OOMAnalyser is a small project to transform the OOM message of a Linux kernel into a more user-friendly format.

This project is written in Python and it uses [Transcrypt](https://www.transcrypt.org/) to
compile the Python sources into JavaScript.
OOMAnalyser consists of a web page into whose input field the OOM message is copied. JavaScript code extracts the data
from it and displays the details. All processing takes place in the browser. No data is transferred to external servers.
This makes it possible to use a locally stored copy of the website for analysis.

The current online version is available on https://www.carstengrohmann.de/oom/.
This project is written in Python and uses [Transcrypt](https://www.transcrypt.org/)  to translate the Python sources
into JavaScript.

The current online version is available at https://www.carstengrohmann.de/oom/ .

## Installation