diff --git a/COPYRIGHT b/COPYRIGHT index ea2039114ce8e623a944bba2cef2c0eee6413b4c..2e18056fc4804b870632d375ce85357547e968a0 100644 --- a/COPYRIGHT +++ b/COPYRIGHT @@ -1,12 +1,11 @@ /* - melno - simple little monochrome countdown timer - https://notabug.org/namark/melno - https://git.sr.ht/~namark/melno - https://git.qoto.org/namark/melno - https://gitlab.com/namark/melno - https://github.com/namark/melno + truwo - simple exercise timer + https://notabug.org/namark/truwo + https://git.sr.ht/~namark/truwo + https://git.qoto.org/namark/truwo + https://github.com/namark/truwo - Copyright (C) 2017-2020 respective authors/contributors + Copyright (C) 2020-2021 respective authors/contributorsZ This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by diff --git a/README.md b/README.md index 50587de6aa2895fdc6fcdba6853199132ffb6dae..1888eb38805acd96b49ea3a93761ef41f25db39a 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,16 @@ -This is a simple GUI timer that can count up and down, and play sound when reaches 0. +This is a simple GUI timer sequencer. ## Use instructions ### Overview -The timer shows hours, minutes and seconds from left to right. You can set the time by clicking on the section of the timer and typing in the numbers. <br /> -On the right side there are three buttons: -1. Top button, starts the timer counting up. -2. Bottom button, starts the timer counting down. -3. Middle button pauses the timer, or if long pressed rests to the value that was set before the countdown started. -When the timer reaches zero it plays a sound. Unless specified otherwise it would be the melno.wav file in the "current directory". In this alarm state all controls are disabled except the middle button which will stop the sound and reset the timer when pressed.<br /> -There a usual concept of focus that works with mouse and keyboard controls for it. Tab and Shift+Tab keys will move the focus between the controls. When focused on a section of time display you can input a number. When focused on a button you can press it with the Space key (long press would also work).<br /> -Note that you can start several instances of the application at the same time, they don't remember any state and should not interfere with each other. +WIP <br /> ### Special secret dangerous command line parameters -When starting the application from command line there are 8 positional parameters that you can specify: -1. The name of the audio file to be played when timer reaches 0 (default: ./melno.wav). Currently only WAV format is supported. You can specify an empty string to disable sound. -2. The hours to set the timer to (default: 0). -3. The minutes to set the timer to (default: 0). -4. The seconds to set the timer to (default: 0). -5. The primary/foreground color of the UI, specified as a number/code. (default: 0x009dff). -6. The secondary/background color of the UI, specified as a number/code. (default: 0x000000). -7. The frame time in milliseconds (default: 33). -8. The frame time when the application is minimized, in milliseconds (default: 256) +When starting the application from command line there are 4 positional parameters that you can specify: +1. The name of the audio file to be played when timer reaches 0 (default: ./truwo.wav). Currently only WAV format is supported. You can specify an empty string to disable sound. +2. The primary/foreground color of the UI, specified as a number/code. (default: 0x009dff). +3. The secondary/background color of the UI, specified as a number/code. (default: 0x000000). +4. The frame time in milliseconds (default: 33). Any invalid input (non existent files, wrong file formats, wrong number formats, etc.) will gracefully crash the application.<br /> The audio file is loaded into memory in its entirety when the application starts, so be careful with large files. @@ -40,6 +29,7 @@ Below are build instructions for GNU systems (including cygwin on Windows), prim [libsimple_interactive](https://notabug.org/namark/libsimple_interactive) <br /> [libsimple_musical](https://notabug.org/namark/libsimple_musical) <br /> [libsimple_geom](https://notabug.org/namark/libsimple_geom) <br /> +[libsimple_motion](https://notabug.org/namark/libsimple_motion) <br /> [libsimple_support](https://notabug.org/namark/libsimple_support) <br /> [libsimple_sdlcore](https://notabug.org/namark/libsimple_sdlcore) <br /> [cpp_tools](https://notabug.org/namark/cpp_tools) <br /> diff --git a/docs/2_compile_and_run.md b/docs/2_compile_and_run.md index 5c4caf1786cf7d1dd070e6fbe1768dc44b3d593a..97aa14e4d0b4c044b59976ee97d5df859ce49fdd 100644 --- a/docs/2_compile_and_run.md +++ b/docs/2_compile_and_run.md @@ -3,8 +3,8 @@ ## Common for all GNU systems 1. For the sake of completeness - obtain the project and change directory to its root: ```bash -git clone https://notabug.org/namark/melno -cd melno +git clone https://notabug.org/namark/truwo +cd truwo ``` 2. If you had to manually install the c++ compiler it's like not the default one, so will need to manually specify it for `make`: @@ -25,7 +25,7 @@ make 5. After compilation the executable file will be created in the `out` folder. You can run it like so: ```bash -./out/melno "" +./out/truwo "" ``` It can be used as is, or installed system wide using `make install` (or `checkinstall` on Debian based systems). `make unisntall` will uninstall it (use package manager in case of `checkinstall`). @@ -53,15 +53,15 @@ cp /usr/x86_64-w64-mingw32/sys-root/bin/*.dll ./out/ ``` That's it! Here is an overview: ```bash -git clone https://notabug.org/namark/melno -cd melno +git clone https://notabug.org/namark/truwo +cd truwo export CXX=x86_64-w64-mingw32-g++ export AR=x86_64-w64-mingw32-ar ./tools/setup/init.sh export CXXFLAGS="-DSDL_MAIN_HANDLED" make cp /usr/x86_64-w64-mingw32/sys-root/mingw/bin/*.dll ./out/ -./out/melno "" +./out/truwo "" ``` <br />