From 01b54b428b17ac0123262ed77a810d060a0f7644 Mon Sep 17 00:00:00 2001 From: nojhan Date: Wed, 29 Nov 2017 21:39:11 +0100 Subject: [PATCH] example of snapshot name --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index bb8136d..4c6110c 100644 --- a/README.md +++ b/README.md @@ -9,22 +9,25 @@ along with the precise date of this version. This may be useful for digital artists that want to prepare a time-lapse of their on-going work without having to think about it. -# Usage +## Usage You should start FlickSave with the file you want to save as an argument and let it run during the time you want to create snapshots. Once started, it will watch for modifications on the given file and create the snapshots by himself each time something happens. -## Synopsis +By default, the snapshot has the same name than the targeted file, with the addition of the timestamp. +For instance, with a target file named `test.svg`, a snapshot will look like `test_2017-11-28T21:02:59.svg`. + +### Synopsis `flicksave.py [-h] [-d DIRECTORY] [-y DELAY] [-s SEPARATOR] [-t TEMPLATE] [-v {DEBUG,INFO,WARNING,ERROR}] target` -## Required positional argument +### Required positional argument `target`: The file to save each time it's modified. -## Optional arguments +### Optional arguments * `-h`, `--help`: show this help message and exit. * `-d DIRECTORY`, `--directory DIRECTORY`: The directory in which to copy the saved versions. (default: .) @@ -34,9 +37,9 @@ and create the snapshots by himself each time something happens. * `-v {DEBUG,INFO,WARNING,ERROR}`, `--verbose {DEBUG,INFO,WARNING,ERROR}`: Verbosity level. (default: WARNING) -# Examples +## Examples -## Command line +### Command line Just start FlickSave with your target file as an argument: @@ -60,6 +63,6 @@ If you want to see what's going on and when the snapshots are created, ask it to [1]+ Complété ./flicksave.py -v INFO test.txt -# Authors +## Authors Original Author: nojhan ([![endorse](https://api.coderwall.com/nojhan/endorsecount.png)](https://coderwall.com/nojhan))