@@ -19,6 +19,9 @@ Why use this instead of the many other time signal generators available? Three p
1919 supported clock or watch.
2020
2121## Quick Setup Guide
22+ Try it online [ here] ( https://timesignal.pages.dev/ ) !
23+
24+ Alternatively, to install the program locally:
22251 . Install a recent version of [ Rust] .
2326 - On Linux, you may also need to install the ` libasound2-dev ` package on Debian-based
2427 distributions or ` alsa-lib-devel ` on Fedora.
@@ -33,7 +36,7 @@ clock or watch are in reception mode!
3336As an alternative to step 3 above, you can build and run the program separately:
3437
35383 . Run ` cargo build -r `
36- 4 . Run ` target/release/timesignal <signal> `
39+ 4 . Run ` ./ target/release/timesignal <signal>`
3740
3841## Command Line Options
3942The general form for running this program is
@@ -94,10 +97,12 @@ timesignal -t "2024-06-03 17:21:05.692 -08:00" wwvb
9497```
9598
9699## Modifying the Code
97- Feel free to modify and add code as you see fit. To build the documentation, run ` cargo doc` and
98- then open ` target/doc/timesignal/index.html ` . To run unit tests, run ` cargo test` or if you have
100+ Feel free to modify and add code as you see fit. To build the documentation, run ` just doc` and
101+ then open ` target/doc/timesignal/index.html ` . To run unit tests, run ` just test` or if you have
99102[ cargo-nextest] run ` cargo nextest run ` .
100103
104+ If you don't have [ just] , you can open and run the commands from ` justfile ` manually.
105+
101106Documentation for the Junghans message format can be found at the top of ` src/junghans.rs ` .
102107
103108[ DCF77 ] : https://en.wikipedia.org/wiki/DCF77
@@ -112,3 +117,4 @@ Documentation for the Junghans message format can be found at the top of `src/ju
112117[ TZ string ] : https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html
113118[ cargo-nextest ] : https://nexte.st/
114119[ Javascript ] : https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date#date_time_string_format
120+ [ just ] : https://github.com/casey/just
0 commit comments