Skip to content

Commit

Permalink
add install details to the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kubec committed Jun 3, 2021
1 parent 7bc9a41 commit 597878c
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 13 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@
*.log
chia-log-analyzer
builds
*debug*
*debug*
sign-code
39 changes: 27 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,38 @@
# Chia log analyzer
Simply realtime chia log analyzer

## Howto run
```
chia-log-analyzer.go-linux-amd64 --log=/path/to/debug.log
```
or simply copy binary file to the directory with logs and run without parameters
![Screenshot](./docs/screenshot-1.png)

## Howto run on Linux
0) Download binary from the [releases](../../releases) assets (chia-log-analyzer.go-linux-amd64
)
1) You must set log level in your chia ```.chia/mainnet/config/config.yaml``` to level: INFO

![Screenshot](./docs/screenshot-2.png)

2) Set binary as executable: ```chmod +x chia-log-analyzer.go-linux-amd64```

3) Run executable with path do debug.log: ```./chia-log-analyzer.go-linux-amd64 --log=/path/to/debug.log```

4) Or simply copy binary file to the directory with logs and run without parameters ```./chia-log-analyzer.go-linux-amd64```

## Howto run on Windows
0) Download binary from the [releases](../../releases) assets (chia-log-analyzer.go-windows-amd64-signed.exe
)
1) You must set log level in your chia ```C:\Users\<CurrentUserName>\.chia\mainnet\config\config.yaml``` to level: INFO

### debug.log locations
![Screenshot](./docs/screenshot-2.png)

2) Simply copy exe file to the directory with logs (```C:\Users\<CurrentUserName>\.chia\mainnet\log```) and run ```chia-log-analyzer.go-windows-amd64-signed.exe```

3) Or run executable with path do debug.log: ```hia-log-analyzer.go-windows-amd64-signed.exe --log=:\Users\<CurrentUserName>\.chia\mainnet\log\debug.log```

## debug.log locations
Automatically trying to load debug.log from these locations:
* ./debug.log (actual directory)
* get log path from the parameter **"--log"**
* ~/.chia/mainnet/log/debug.log (default directory in home dir)

![Screenshot](./docs/screenshot-1.png)

## Howto install
Download binary from the [releases](../../releases) assets

## Features
- monitoring of chia debug.log file
- simply show basic info about farming
Expand All @@ -29,7 +44,7 @@ Download binary from the [releases](../../releases) assets
## Supported platforms
- Linux (tested on Ubuntu) - download binary: **chia-log-analyzer.go-linux-amd64**
- RPI4 (use linux-arm builds) - download binary: **chia-log-analyzer.go-linux-arm**
- Windows10 - download binary: **chia-log-analyzer.go-windows-amd64.exe**
- Windows10 - download binary: **chia-log-analyzer.go-windows-amd64-signed.exe**

## Keys
- **q** - exit
Expand Down
Binary file added docs/screenshot-2.png
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 597878c

Please sign in to comment.