Skip to content

Commit

Permalink
#112: updates Readme.md - introduces Usage.md for faster start page l…
Browse files Browse the repository at this point in the history
…oading time
  • Loading branch information
rladstaetter committed Oct 30, 2022
1 parent 1aaa272 commit be32cc2
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 16 deletions.
35 changes: 19 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
# `LogoRRR`

While exploring the log files is an essential part of troubleshooting, sometimes you may not want to go so deep. In fact, when you get an error, you may simply want to see what happened as fast as possible and in a clear way. `LogoRRR` is a tool that does precisely that and provides you with a quick way to filter out critical events or other points of interest.
While exploring the log files is an essential part of troubleshooting, sometimes you may not want to go so deep. In
fact, when you get an error, you may simply want to see what happened as fast as possible and in a clear way. `LogoRRR`
is a tool that does precisely that and provides you with a quick way to filter out critical events or other points of
interest.

![Screenshot of LogoRRR, version 22.3.0](docs/releases/23.1.0/screenshot-23.1.0.png?raw=true)

## Basic usage
## Usage

![Shows basic functionality of `LogoRRR` as animated gif](docs/releases/21.3.1/screencast-21.3.1.gif?raw=true)

For example, ERROR events are visualized as red rectangles, TRACE events as grey rectangles, INFO events as green ones etc.

You can start `LogoRRR` via double click from the desktop. Add a log file or directories containg log files via drag'n drop or using the file menu.
If you want to see [LogoRRR in action](Usage.md), click [here](Usage.md).

## Technology

See [Technology](Technology.md) for a short summary of used technologies.

## Installation

You can give it a try by downloading a [prebuilt installer for `LogoRRR`](https://github.com/rladstaetter/LogoRRR/releases/tag/22.3.0) from the releases page. There are installer for Windows and MacOs available.
## Installation

You can give it a try by downloading
a [prebuilt installer for `LogoRRR`](https://github.com/rladstaetter/LogoRRR/releases/tag/22.3.0) from the releases
page. There are installer for Windows and MacOs available.

## Features

Expand All @@ -31,20 +31,23 @@ You can give it a try by downloading a [prebuilt installer for `LogoRRR`](https:
- Filter log files for entries interactively
- Case sensitive and regex search
- Unix `tail -f` like functionality to watch ongoing events
- Keyboard shortcuts for more efficient usage
- Keyboard shortcuts for more efficient usage

## Sponsoring

If you find this project useful you can [buymeacoffee](https://www.buymeacoffee.com/rladstaetter).

Alternatively, just hit the 'star' here on github, or drop me a line at twitter: [@logorrr](https://www.twitter.com/logorrr/).

A big shoutout goes to @TheJeed and @raumzeitfalle for sponsoring this project and boosting my motivation to continue working on it. Thank you!
Alternatively, just hit the 'star' here on github, or drop me a line at
twitter: [@logorrr](https://www.twitter.com/logorrr/).

I want to thank my employer [NEXTSENSE](https://www.nextsense-worldwide.com/) as well for generously providing vital infrastructure to create this application.
A big shoutout goes to @TheJeed and @raumzeitfalle for sponsoring this project and boosting my motivation to continue
working on it. Thank you!

[Advanced Installer](https://www.advancedinstaller.com) sponsors this project too by providing a free license to their product which is used to create windows installers. Thank you.
I want to thank my employer [NEXTSENSE](https://www.nextsense-worldwide.com/) as well for generously providing vital
infrastructure to create this application.

[Advanced Installer](https://www.advancedinstaller.com) sponsors this project too by providing a free license to their
product which is used to create windows installers. Thank you.

## License

Expand Down
14 changes: 14 additions & 0 deletions Usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Usage

You can start `LogoRRR` via double click from the desktop. Add a log file or directories containg log files via drag'n
drop or using the file menu.

## Drop files via mouse to `LogoRRR`

![Drag'n drop files to `LogoRRR`](docs/releases/21.3.1/screencast-21.3.1.gif?raw=true)

## Use `LogoRRR` as log monitor

![Use LogoRRR as log monitor](docs/releases/23.1.0/logorrr-autoscroll.gif?raw=true)


Binary file added docs/releases/23.1.0/logorrr-autoscroll.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit be32cc2

Please sign in to comment.