From 57b34139a541d9152fad310b0840853de4834414 Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Sun, 19 Jun 2016 03:13:42 +0300 Subject: README update --- README.md | 1 + docs/images/date.png | Bin 0 -> 14223 bytes docs/images/hour.png | Bin 0 -> 53227 bytes docs/images/online_duration/date.png | Bin 14223 -> 0 bytes docs/images/online_duration/hour.png | Bin 53227 -> 0 bytes docs/images/online_duration/user.png | Bin 20610 -> 0 bytes docs/images/online_duration/weekday.png | Bin 33239 -> 0 bytes docs/images/user.png | Bin 0 -> 20610 bytes docs/images/weekday.png | Bin 0 -> 33239 bytes docs/track_status.md | 7 +++++-- 10 files changed, 6 insertions(+), 2 deletions(-) create mode 100644 docs/images/date.png create mode 100644 docs/images/hour.png delete mode 100644 docs/images/online_duration/date.png delete mode 100644 docs/images/online_duration/hour.png delete mode 100644 docs/images/online_duration/user.png delete mode 100644 docs/images/online_duration/weekday.png create mode 100644 docs/images/user.png create mode 100644 docs/images/weekday.png diff --git a/README.md b/README.md index dd02c98..0a9438d 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ The main package is located in the "vk/" directory. Additionally, a few scripts are supplied in the "bin/" directory to show-case the package's capabilities. +Run the scripts from the top-level directory using `python -m`. Pass the `--help` flag to a script to see its detailed usage information. The supplied scripts are listed below. diff --git a/docs/images/date.png b/docs/images/date.png new file mode 100644 index 0000000..477c530 Binary files /dev/null and b/docs/images/date.png differ diff --git a/docs/images/hour.png b/docs/images/hour.png new file mode 100644 index 0000000..cad26b3 Binary files /dev/null and b/docs/images/hour.png differ diff --git a/docs/images/online_duration/date.png b/docs/images/online_duration/date.png deleted file mode 100644 index 477c530..0000000 Binary files a/docs/images/online_duration/date.png and /dev/null differ diff --git a/docs/images/online_duration/hour.png b/docs/images/online_duration/hour.png deleted file mode 100644 index cad26b3..0000000 Binary files a/docs/images/online_duration/hour.png and /dev/null differ diff --git a/docs/images/online_duration/user.png b/docs/images/online_duration/user.png deleted file mode 100644 index 13a7420..0000000 Binary files a/docs/images/online_duration/user.png and /dev/null differ diff --git a/docs/images/online_duration/weekday.png b/docs/images/online_duration/weekday.png deleted file mode 100644 index 5cf659e..0000000 Binary files a/docs/images/online_duration/weekday.png and /dev/null differ diff --git a/docs/images/user.png b/docs/images/user.png new file mode 100644 index 0000000..13a7420 Binary files /dev/null and b/docs/images/user.png differ diff --git a/docs/images/weekday.png b/docs/images/weekday.png new file mode 100644 index 0000000..5cf659e Binary files /dev/null and b/docs/images/weekday.png differ diff --git a/docs/track_status.md b/docs/track_status.md index 8bbb380..a682005 100644 --- a/docs/track_status.md +++ b/docs/track_status.md @@ -30,10 +30,13 @@ For example (using made up user IDs/"screen names"), By default, the script produces a human-readable log. Use the `--log` parameter to write the log to a file. -If you want to record when people go online/offline for [further analysis], -specify the path to a database using the `--output` parameter. +If you want to record when people go online/offline for further analysis using +[online_duration.py], specify the path to a database using the `--output` +parameter. Be careful: if the file already exists, it will be overwritten! +[online_duration.py]: online_duration.md + See also -------- -- cgit v1.2.3