diff --git a/Cargo.toml b/Cargo.toml index a68f751..4b3d5e9 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "contrac" description = "ISP connection tracker" -version = "0.4.0" +version = "0.5.0" authors = ["John Shewchuk "] edition = "2018" repository = "https://github.com/johnshew/contrac" diff --git a/README.md b/README.md index 5038a72..b9b196f 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,35 @@ # Contrac -Track your Internet Service Provider and generate a log of down time. +Contrac monitors your Internet Service Provider and generates a log of down time. This tracker pings Google, Cloudflare, and Cisco to determine connectivity. -## Notes +This windows app is a single file .exe, with embedded resources, tray notification, and window minimization to the tray. + +## Installation -Resources +Copy the latest release of the exe to your computer from here -#! for windows - no console +https://github.com/johnshew/contrac/releases -Should add minimimize and restore to native-windows-gui +Since Contrac automatically writes to the log files every 5 minutes it is good to put the exe in the directory you want the logs to go. + +## Notes +This was an interesting first project to learn Rust. Thanks to [Gabriel Dube](https://github.com/gabdube) for creating native-windows-gui, a nice toolkit for small native Win32 apps. -Might want to include WS_CLIPSIBLINGS in flags. +The graph rendering in Contrac is a hack. Since there are currently no easy-to-use drawing capabilties with native-windows-gui, Contrac uses a collection of small image controls to represent the bars of the graph. +On Windows, by default, Rust starts a console. If you want a Windows app put the following at the top of main.rs. -### Recommended Visual Studio Extensions +``` #![windows_subsystem = "windows"] ``` + +Here a few things that I thought about PRing into native-windows-gui: +* Minimize and restore windows +* Maybe enable WS_CLIPSIBLINGS in flags for controls and enable z-ordering +* Provide more access to the nwg::win32 helper functions + +## Recommended Visual Studio Extensions * https://marketplace.visualstudio.com/items?itemName=rust-lang.rust * https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb -