Update 'README.md'
This commit is contained in:
parent
50dccdf758
commit
329da89904
10
README.md
10
README.md
|
@ -1,19 +1,27 @@
|
|||
# watts_to_dollars
|
||||
|
||||
A tiny cli program written in Nim to calculate how much money a device will cost in electricity for a given number of days. Written and tested for linux. There may not be anything OS specific, but i haven't checked.
|
||||
A tiny cli program written in Nim to calculate how much money a device will cost in electricity for a given number of days. Written and tested for linux. There may not be anything OS specific, but i haven't paid any attention to that.
|
||||
|
||||
# Building from source
|
||||
You will need Nim installed, which also contains Nimble, the Nim package manager.
|
||||
|
||||
install the termstyle dependency: `nimble install termstyle`
|
||||
|
||||
compile watts_to_dollars.nim with: `nim c --d:threads:off -d:release --opt:speed watts_to_dollars.nim`
|
||||
|
||||
copy the binary to `~/.local/bin` and make it executable.
|
||||
|
||||
run the program from any location in the terminal with: `./watts_to_dollars`
|
||||
|
||||
|
||||
# Running the binary
|
||||
Download watts_to_dollars_x86_64_linux_bin
|
||||
|
||||
Rename it if you want and copy it to `~/.local/bin`
|
||||
|
||||
run the program from any location in the terminal with: `./watts_to_dollars` or whatever you renamed it.
|
||||
|
||||
|
||||
# How To Use
|
||||
The idea is to enter the total watts of a device, or the difference in watts between two devices, if you want to see how much those watts will cost you on your electricity bill. It uses days as the time unit for simplicity, so you can use `31` for a month or `365` for a year if you want to.
|
||||
|
||||
|
|
Loading…
Reference in New Issue