ScreamingHot/README.md

29 lines
787 B
Markdown

# Screaming Hot
Make your computer scream when it gets hot !
# Limitations
This only handles temperature reading for Linux, as it is exposed by a simple file. Not tested on MacOS.
# Usage
Running the program without arguments will use default values set in code.
The two first arguments set the minimum and maximum temperature of the range, the third sets the number of samples for
averaging it temperature readings and the fourth the file where temperature should be read from.
Any other number of arguments or a number that cannot be parsed will print out the usage details.
Pressing `Escape` will quit the application.
# Building
## Dependencies
- SFML
- Audio
- Window
- System
## Sources
`scream.ogg` is a short extract from Rick and Morty, © Adult Swim.