Georg/OOMAnalyser
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rework the README

Browse Source
This commit is contained in:
Carsten Grohmann 2017-12-21 22:00:34 +01:00
parent 5407030a89
commit 3887d12ee7
1 changed files with 40 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
README.md
View File

@ -1,4 +1,4 @@
# Linux OOM Analyser # Linux OOMAnalyser
I've started this project to give the Python to JavaScript compiler I've started this project to give the Python to JavaScript compiler
[Transcrypt](https://www.transcrypt.org/) a try. [Transcrypt](https://www.transcrypt.org/) a try.
@ -9,7 +9,6 @@ format.
You can use the current version on [www.carstengrohmann.de/oom/](https://www.carstengrohmann.de/oom/). You can use the current version on [www.carstengrohmann.de/oom/](https://www.carstengrohmann.de/oom/).
## Design Goals ## Design Goals
* A local copy of the web page should run offline - without an Internet * A local copy of the web page should run offline - without an Internet
connection, without loading 3rd party libraries nor transferring data to connection, without loading 3rd party libraries nor transferring data to
@ -17,57 +16,75 @@ You can use the current version on [www.carstengrohmann.de/oom/](https://www.car
* A better understanding of the Linux Memory Management * A better understanding of the Linux Memory Management
* Start learning JavaScript, CSS and HTML * Start learning JavaScript, CSS and HTML
## Build and Installation
## Requirements
This section describes a manual build and installation of OOMAnalyser.
### Requirements
* [Python](http://www.python.org) 3.6 or later * [Python](http://www.python.org) 3.6 or later
* [Transcrypt](https://www.transcrypt.org/) 3.6.53 or later * [Transcrypt](https://www.transcrypt.org/) 3.6.53 or later
### Setup
## Installation Clone the repository:
Install Python virtual environment
Use the provided Makefile:
``` ```
# make venv # git clone https://github.com/CarstenGrohmann/OOMAnalyser
``` ```
or setup the virtual environment manually: Setup the Python virtual environment:
``` ```
# virtualenv env # virtualenv env
# . env/bin/activate # . env/bin/activate
# env/bin/pip install -Ur requirements.txt # env/bin/pip install -Ur requirements.txt
```
## Build or
Use the provided Makefile:
```
# make venv # make venv
``` ```
or build it manually: ### Build
``` ```
# . env/bin/activate # . env/bin/activate
# transcrypt --build --map --nomin -e 6 OOMAnalyser.py # transcrypt --build --map --nomin -e 6 OOMAnalyser.py
or
# make build
``` ```
## Usage
* Change into the source directory and start your own small web server.
* Start Python built-in web server:
* ```
# python3 -m http.server 8080 --bind 127.0.0.1
or
# make websrv
```
* Open the URL [http://localhost:8080/OOMAnalyser.html](http://localhost:8080/OOMAnalyser.html) in your favorite browser.
* That's it!
## Further Information ## Further Information
* [Transcrypt](https://www.transcrypt.org/). * [Transcrypt](https://www.transcrypt.org/)
* [Linux man pages online](https://man7.org/) * [Linux man pages online](https://man7.org/)
* [Decoding the Linux kernel's page allocation failure messages](https://utcc.utoronto.ca/~cks/space/blog/linux/DecodingPageAllocFailures) * [Decoding the Linux kernel's page allocation failure messages](https://utcc.utoronto.ca/~cks/space/blog/linux/DecodingPageAllocFailures)
* [Linux Kernel OOM Log Analysis](http://elearningmedium.com/linux-kernel-oom-log-analysis/) * [Linux Kernel OOM Log Analysis](http://elearningmedium.com/linux-kernel-oom-log-analysis/)
## Known Bugs/Issues ## Known Bugs/Issues
Check the bug tracker on [GitHub](https://github.com/CarstenGrohmann/OOMAnalyser/issues) for current open bugs. Check the bug tracker on [GitHub](https://github.com/CarstenGrohmann/OOMAnalyser/issues) for current open bugs.
New bugs can be reported there also. New bugs can be reported there also.
## License ## License
This project is licensed under the MIT license.
``` ```
Copyright (c) 2017 Carsten Grohmann mail <add at here> carsten-grohmann.de Copyright (c) 2017 Carsten Grohmann, mail <add at here> carsten-grohmann.de
Permission is hereby granted, free of charge, to any person obtaining a copy of Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in this software and associated documentation files (the "Software"), to deal in
@ -89,4 +106,4 @@ SOFTWARE.
``` ```
Enjoy! Enjoy!
Carsten Grohmann Carsten Grohmann