ministo

A tmux status bar and scripts for CPU miners.
git clone git://git.swab.dev/ministo.git
Log | Files | Refs | README | LICENSE

README.md (1665B)


      1 # Ministo
      2 
      3 Ministo is a collection of scripts to display useful information when mining Monero, Wownero, or another CPU mined cryptocurrency.
      4 
      5 ## General Information:
      6 ### CPU Temps:
      7 If sensors returns `coretemp` data the `getAverageCpuTemp.sh` script will return the average across all cores.
      8 
      9 If sensors does not return `coretemp` it will look for `Tdie`. This is used for some Ryzen processors and is the tempurature of the CPU die.
     10 
     11 ### CPU MHz:
     12 This is the average of all core MHz as reported by `/proc/cpuinfo`.
     13 
     14 ## Dependencies:
     15 ### Debian/Ubuntu/et. al.
     16 ```shell
     17 sudo apt install sensors bc
     18 ```
     19 
     20 ### Arch, Manjaro. et. al.
     21 ```shell
     22 sudo pacman -S sensors bc
     23 ```
     24 
     25 ### Artix Runing Open-RC
     26 ```shell
     27 sudo pacman -S sensors sensors-openrc bc
     28 ```
     29 
     30 ## Using the Supplied Scripts in tmux:
     31 ### Install tmux:
     32 #### Debian/Ubuntu/et. al
     33 ```shell
     34 sudo apt install tmux
     35 
     36 ```
     37 ### Arch, Manjaro, Artix, et. al.
     38 ```shell
     39 sudo pacman -S tmux
     40 ```
     41 
     42 ### Create tmux config directories:
     43 ```shell
     44 mkdir -p $HOME/.config/tmux
     45 ```
     46 
     47 ### Link scripts to the tmux config directory
     48 This ensures that any updates will be reflected without the need to manually copy in the future.
     49 ```shell
     50 ln -s { path to ministo directory }/getAverageCpuMHz.sh $HOME/.config/tmux/getAverageCpuMHz.sh
     51 ln -s { path to Ministo directory }/getAverageCpuTemp.sh $HOME/.config/tmux/getAverageCpuTemp.sh
     52 ```
     53 
     54 ### Add the following to tmux (customize as desired)
     55 ```shell
     56 set -g status-interval 2
     57 set-option -g status-right-length 150
     58 set-option -g status-right "#[fg=white]#[bg=black]#[fg=white]#[bg=black]CPU: #(sh $HOME/.config/tmux/getAverageCpuMHz.sh) #(sh $HOME/.config/tmux/getAverageCpuTemp.sh) | "
     59 ```