From 597878c61dc9b0471068ee76b335ac6d5078909d Mon Sep 17 00:00:00 2001 From: Michal Kubec Date: Thu, 3 Jun 2021 09:37:17 +0200 Subject: [PATCH] add install details to the documentation --- .gitignore | 3 ++- README.md | 39 +++++++++++++++++++++++++++------------ docs/screenshot-2.png | Bin 0 -> 5834 bytes 3 files changed, 29 insertions(+), 13 deletions(-) create mode 100644 docs/screenshot-2.png diff --git a/.gitignore b/.gitignore index a2d4822..b034b6b 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,5 @@ *.log chia-log-analyzer builds -*debug* \ No newline at end of file +*debug* +sign-code \ No newline at end of file diff --git a/README.md b/README.md index ea8174e..8130764 100644 --- a/README.md +++ b/README.md @@ -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\\.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\\.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\\.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 @@ -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 diff --git a/docs/screenshot-2.png b/docs/screenshot-2.png new file mode 100644 index 0000000000000000000000000000000000000000..94f05017c5df7bdc4f9d5a3f925eaec9af745c73 GIT binary patch literal 5834 zcmZvAcQoA5)Av_P5G8uA(Yqj`M<(gk zZ_n=)j<1rYAwE9-(wffS`z@WHs;QrW*IT~;TOUWj$Jx{b6Dj`?b z)Mn=?_V5qbd>^rIp6uey3F$u}m~2yIWNF;eXe=H|DW6Yy%|uy|%FgSfDHMpv zC0b2Vwu=pOqS>YLp`Rc+P;@XfPzJMojLv0gy&cebp=9^@1I-c^K{R{PR!6^)@U7m) zgb71pxBgi%n*uWy5MEM&h!2(4Vpbm@@ecEI<6C*|EMkWT(zFwOya3uMVu7ySHCSSX zUR_;Zq_Q6+p0Y*`?$b804va1holhsd%=49dch@Kb6B=QOGldKWy-C-9SX~r$axof} zNaMyWc;%EW(Lz1MqZ8sEa_aLOEtZ=3D*DK`*S>orz&;u~p}batrBO6LpAL+gzEGu! zrA8z=<{oO`z;_uh7d`_97Uwk}4xz;a3fjX*Hk}j%?4nKN?VQ7yu1roJ6!m_pMB0Om z9Fo=O+V5h4!NqAhNA>>mj@81~C12q7(Vd|%r1Hl@mH5N{9}+&m?A|5B_h-dYzWZ?Z zH$lbKB<&?THdb2sg}rtrvKCSxT#t|rFXZ_cDhu8(68^4pwf_Mb1O8~HaZngQIaKCv zx;RWQ#?pO|wYdJq@D<{A#{ zCg|X5PlL-Q<8730!kw(l-m@%dm!>8*Fz~H)(VvgKUt0=1GhE|Q>`-y5bl5}k<92WP zR?>@OyV`KXxF&O#{&ElVgoYfUJj&Nz&IACjyFbxyqQ?~I5?y#0c;P~N96rrQ-i~fH2ewERG{*)i za{N?{N@CHR4ybUgQR!M499bgPK{Rfy?Y;p^W7ez*03E9o00BymprQMHCQDoICm$5L<~ZZ z6_;x(apNrmQj{ddw4}2GTY%+rpK%>S=iMLL+VA1ci4?2#YBj$UODCG=9#@d*7CN!o zT6!GSC(k~;`Os4A#wwfeX$dQwwOXyxk~LXdyzh@3w{r<5`D{cgvWQAn*Olw7DuFPWIdLS%yS5V9h^k=5+CAW3EIRHh1Md$bz9_peRZC zig!TF6bm&e66`h;aMm4mNW{H8lgE!CCvO_Wc=5T+HZN!rf8ZtlmLR>*^A1s$r*zof zD9pyDv~s5wH8`kcAvj*{om0vp|Lz8yN#Qk~9!fw!M%X@{oWw&_+=LUI9@TurY0MtD zvbs@8W77!H147o}gUPYCA@NTncdg-$=4Ba!>pyLnP(<1##HQaWt@%lB`~8?53$6!g zKA+h@O4lEPCg?6}e0!oiFqIblYG822;HyQ|mF?^ukPT}tVRy%Z;bHdseRuKRqOA6( zO=s+%Cr3A9uP?mJO)kwnHgl(LqxFaBhL+CEsijtFYYl8uBfOD0n_K@fkr$?VA?DJ5 zV`{3laO4V7EKVK1hfPE5(U)W;w)ws&?~v5q!HlS=GR ze!ufdv^8$@u2r1Gwz3w&RZj8bAoJJVLd#!T92LifRZq4^mqzX6i*@FvTC*w?CJfc? zl}6E+&+#bq_1H#5^(4e@4b5b*19dqQ|9FfA^voc3NDz|W{?*I8N1SX%IG=P(yEC%{ z?vO+Pjy)r`8l6>&bI z+G%F%iqT~qGqk&Bivgg15Y ziuN{Ja(72?#M{(R-tIgV5VYIX_1%t8V;+;bdi0O}N zQHK;8lA?#nhvvES0*zhW?RiK_Rde(L!tf;CvL%#ic3HxEYV_h)^brI2i(->@_LWHd z3SJUw&0(i#-Zbg#vM7VOkIJ}2Dyx7dn)GV7K=avAtQ2-b^5a?)+x2tb9;FRUQ$LHA z2L2lZof7OIdhff9C*8gzi!^ao2$J9Ki!+3_3cjFFnl5lm^LPP1&d&tdQUkqA%J5X5 zCorOs>14{yOA3=zWBnDM`U3k70#SLsz>Swh0a(CLwaolmQztG%+(@i{Y+UIMBW%>b z`#v9hEW5y@K@nRFK5I$hp5+KGHLcFVVvD)^0LY84eo7?h)h{RZC+&YQRh&%?7LU$=)r+C%1VVq+%= z=*c8npJt>jmLuqx7rU|xeZzvs>g{}W{c;>DNX*V%*=VK;QEiC8s=B7aS0Y&=T<|K8N zxJ8WRmOE6iN!kxpU4>$fgStJvq(1L@wo_na>CHu0n zdo_lwMty;QAgzm3!Uz6b+(h#`I2pgdpZZ?6M3Rh+;v!mqoi4a*cbPb~JE~Yo3Ei8yFO?MB9DJ*gI zS+5bp62=~R6LOeTxzo2x!&d*yq^sLoO`6TFE{92ePwhog_A`t8%93VU$!7;L6I6^& zQ^Y)ML;CZp!VfRH-JaadM9e^pj`};Hoy_*MZ?8g#CHKsUf1-R-`t*1%ZcF~AG2*H! z;{#PLf_G|op{2fl_r95fmek6Saph`bOJ-SzeY-lL*ooiF#^pWa z7pCVPm(tc@)w7CvY__YqP8KBlk3C(eaVY z%~|GWiJW-j%d7U{G&q);rQJ!i(fr}DT*bmFvjUHnHI1do<-NV)yvp?@jQKAoq9Vqp z6>9Ey8>eHVdSISJwl(pTY*$9=WQ(JZw_s`fd^jaed)^h(zUTi5_Ln9XUyo{}g59M5 zktEk)`V_UVw7sa45^t?iz%?9S{Gm@IrJjyA`|a%XpWPSFtxKQAX0O{VC(a|dQ0G3A z#-%dNiga{@#2R0u7MkjVxEC5Pu6WFrNZX1we74T1Q7c@_=8wowDo5>^#Z2-E0&Ya{ zrWYs%GUPN?vBq8VIaXtN8FqLbvi!2C=E}&NXs-NO-E50XW|guyw~4#?E4-_S#C1SC zcInh@8r~C;6!8F*~7O)#(kAExv;at)n#8>1rb|ZqmJ#f z)igdYfL0H?30DMQGv`p#aj@Uel={vOPeMS^bHR1lO3US)JY`f^;BSzG1i$;?Scg+) zbW^qeD&J?4`P=NV)pJoEs}PagwQbHO=YJ{0J~L6ddNjs=10t)& zq~!F5oJq>=oaqSqDz%JahgwY(7GqO$=qReSRGWOdicq%MVR!?|=C^5_D3h^rdgzRz zAEsFBix>ThV>Xo#Q)aYgPXo`m*&K_fS7!GIu?nS?h3`+x>^B^}%Ck-Nu9NUS2+{3^ zIcE{c$GuUj(mx`x+&vDJ%G8~;IA@@kQ!~qRVgj4>KVzaNkkMR*_*ZjJl`E!~{Zu2L`H!X`Pq2#C z{<$99zK|t+V{UPq>w2{rIJfs>t$;`E4}l5dqy1M`Wj89#_AZuN+x3tz_AykdUYfjo z^u?L=>Tl7`_Jo^LNW$v!iB*V-7y#_;@WXAKt(E5R>dGaX(+iFio-4G`y{#O<#QDwb zPHR7Y62M%3tBuo(Z3xB6Qh- z_9O?iEspqjMfJLhot2U0U&GJ)R<#M;3Uz<0!r`~=Khn=CO%FxdChLaalI3{$MHa%z&G~5rFPuR*ZE_N+=@}VCON+fqPu42 z^7YU^C=wcU$DhlfT%IDdWLq;RqDb*qwLkA<6WeW+)?u*gAKws{&bl{y2Lx^W9^$kT z>PR&^Q&rhd{>wL1i_2V2DDiA}yvA8s7pfH8i40-%EZ3b`mxWP|;K+`neu zbRZ5qOX>FOM#8Y!^S6WyzXo|YJ`bsUPu}QQAd?kgDo36JpYSw9CqgkmaN)9UcP8Lq zCiz+C59z}jCn#+&G_kJAFluiAZ(U4Igf!Fr?OqDenaNwU&2F2LLk09_Mf_QDu*fD~ zp02yuuJ$&oWg>1<4djSRIe#UFWF>Dmh0c2Z#ps6I15{qdcQ9U+spE=K6^{W$P=srQ z7B#+zox-uwu_l<-G2(@UF?kx%E9!N!I_Oi#T`!D^V>n3g#F7~Qep24S6p(ftL_d;wZ zA<+NBQH7n#p>GN|;aQ^!Aq%r<5Z>*v+q9Lfh@WBd@}eB%RfRBLsRqh(^f0q+SFB2& z>0(D}ac+AM30W5&PnynQeRBpy&V6LWX!Da|$h@rl$r#fEEM3r+!s3g&>rZnfRIQ{* zT1=FRU9WV;10QuFfVNca; zs6995BZmv$R+pBur1aa(YPU>SJhjnNUPio|yBmfuX{(Cr!0eg`BJjJXl+%0GyWbsd zqskTb$XfHoxmLR&uB6+T1x=gMY5t?d_785Eof|J^5I@&!&a_yD>mLONpRM41bWmM$*pO|-zV_2yskh1%<_G2I zuXVybZHz0A5_mCY`?4omtR6Yyy9(|265A!GB))X`QX4#br$mfiFF!}u#n|` zDL0TRk4Py=;0R@;Htl!BtKS51uLmVGzjk^*b}cdJdy_6OXsw>|j6}6=L%&hr;c|3+ zo_*`e$3zjZ3hgv6=E10;bjSAbd6y+G9R5ZpL=B0V){5bB>cpJv1%#=Yj zqCb}#wI?;XE4ceV_=?x*Gi1{itdK;B#TiH3H-s~-L9W(82?8KmU$VL6;wmWnkH1Fnt5#X~!KpMrJWmz|~R2b+gS{N)PiUi@#g0p87r z`h2!3tuISN3?B30sdZD{Hgl|+_AEeSWkd?XX1QDpgR?wEx+S|oL?-Ali=)-?_35