README.md 2.01 KB
Newer Older
renato's avatar
renato committed
1
2
![LogFX Logo](docs/images/lofx-logo.png)

3
❇️ [Download](https://github.com/renatoathaydes/LogFX/releases/latest)
Renato Athaydes's avatar
Renato Athaydes committed
4

renatoathaydes's avatar
renatoathaydes committed
5
LogFX is a multi-platform, free and open-source log viewer designed to handle very large files without a performance hit.
Renato Athaydes's avatar
Renato Athaydes committed
6

7
It is written in JavaFX so it can run on most Operating Systems.
Renato Athaydes's avatar
Renato Athaydes committed
8

9
🌐 [LogFX Website](https://renatoathaydes.github.io/LogFX/)
renatoathaydes's avatar
renatoathaydes committed
10

11
📚 [Documentation](https://renatoathaydes.github.io/LogFX/docs/index.html)
renatoathaydes's avatar
renatoathaydes committed
12

13
🪲 [Report Issue](https://github.com/renatoathaydes/LogFX/issues/new)
renatoathaydes's avatar
renatoathaydes committed
14

15
📣 [Send private feedback](https://renatoathaydes.github.io/LogFX/contact.html)
renato's avatar
renato committed
16

Renato Athaydes's avatar
Renato Athaydes committed
17
18
## Getting LogFX

renatoathaydes's avatar
renatoathaydes committed
19
20
21
22
23
24
Please choose one of the two alternatives below:

### Stand-alone distributions

LogFX is distributed as a stand-alone application (arond 35MB download, 55MB unpacked).

25
Download the zip file for your distribution, unzip it, then run it with:
renatoathaydes's avatar
renatoathaydes committed
26
27
28
29

```
logfx/bin/logfx
```
Renato Athaydes's avatar
Renato Athaydes committed
30

31
[Linux](https://github.com/renatoathaydes/LogFX/releases/latest) - `logfx-<version>-linux.zip`
Renato Athaydes's avatar
Renato Athaydes committed
32

33
[Mac](https://github.com/renatoathaydes/LogFX/releases/latest) - `logfx-<version>-mac.zip`
renatoathaydes's avatar
renatoathaydes committed
34

35
[Windows](https://github.com/renatoathaydes/LogFX/releases/latest) - `logfx-<version>-windows.zip`
renatoathaydes's avatar
renatoathaydes committed
36

37
### Fat Jar (requires Java 17+ with JavaFX)
renato's avatar
renato committed
38

39
* download the jar from the command-line or your browser:
Renato Athaydes's avatar
Renato Athaydes committed
40

41
> Find the latest version on [Maven Central](https://search.maven.org/search?q=a:logfx).
renatoathaydes's avatar
renatoathaydes committed
42

Renato Athaydes's avatar
Renato Athaydes committed
43
```
renatoathaydes's avatar
renatoathaydes committed
44
VERSION=<latest_version> && \
45
46
  curl https://repo1.maven.org/maven2/com/athaydes/logfx/logfx/$VERSION/logfx-$VERSION-all.jar \
  -o logfx.jar
Renato Athaydes's avatar
Renato Athaydes committed
47
48
```

renato's avatar
renato committed
49
> Size of the jar as of version `0.6.1`: 289 KB. *Not MB!*
50
> UPDATE: Version 1.0's jar size: 272Kb. 
renato's avatar
renato committed
51

renatoathaydes's avatar
renatoathaydes committed
52
53
54
55
56
57
Run with:

```
java -jar logfx.jar
```

58
> Hint: to get Java 17 with JavaFX included, use [SDKMAN!](https://sdkman.io/)
renatoathaydes's avatar
renatoathaydes committed
59

renato's avatar
renato committed
60
61
## Screenshots

62
63
- Linux KDE

renatoathaydes's avatar
renatoathaydes committed
64
![LogFX running on Linux KDE](https://raw.githubusercontent.com/renatoathaydes/LogFX/next/docs/images/screenshots/logfx-1.0rc2-linux.png)
renato's avatar
renato committed
65

renatoathaydes's avatar
renatoathaydes committed
66
67
More in the [Wiki](https://github.com/renatoathaydes/LogFX/wiki/Screenshots) and on the
[Website](https://renatoathaydes.github.io/LogFX/).