nojhan/watchyap
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fix README markdown

Browse source
This commit is contained in:
Johann Dreo 2017-11-29 21:22:26 +01:00
commit b8b7a84321
1 changed files with 11 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -7,22 +7,23 @@ For example, each time you hit `Ctrl-S` within a drawing software,
FlickSave will make a copy the current version of your file, FlickSave will make a copy the current version of your file,
along with the precise date of this version. along with the precise date of this version.
## Usage
# Usage
You should start FlickSave with the file you want to save as an argument 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. and let it run during the time you want to create snapshots.
Once started, it will watch for modifications on the given file Once started, it will watch for modifications on the given file
and create the snapshots by himself each time something happens. and create the snapshots by himself each time something happens.
### Synopsis ## Synopsis
`flicksave.py [-h] [-d DIRECTORY] [-y DELAY] [-s SEPARATOR] [-t TEMPLATE] [-v {DEBUG,INFO,WARNING,ERROR}] target` `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. `target`: The file to save each time it's modified.
### Optional arguments ## Optional arguments
* `-h`, `--help`: show this help message and exit. * `-h`, `--help`: show this help message and exit.
* `-d DIRECTORY`, `--directory DIRECTORY`: The directory in which to copy the saved versions. (default: .) * `-d DIRECTORY`, `--directory DIRECTORY`: The directory in which to copy the saved versions. (default: .)
@ -30,9 +31,11 @@ and create the snapshots by himself each time something happens.
* `-s SEPARATOR`, `--separator SEPARATOR`: Separator character between the file name and the date stamp. (default: _) * `-s SEPARATOR`, `--separator SEPARATOR`: Separator character between the file name and the date stamp. (default: _)
* `-t TEMPLATE`, `--template TEMPLATE`: Template of the date stamp. (default: %Y-%m-%dT%H:%M:%S) * `-t TEMPLATE`, `--template TEMPLATE`: Template of the date stamp. (default: %Y-%m-%dT%H:%M:%S)
* `-v {DEBUG,INFO,WARNING,ERROR}`, `--verbose {DEBUG,INFO,WARNING,ERROR}`: Verbosity level. (default: WARNING) * `-v {DEBUG,INFO,WARNING,ERROR}`, `--verbose {DEBUG,INFO,WARNING,ERROR}`: Verbosity level. (default: WARNING)
## Examples
### Command line
# Examples
## Command line
Just start FlickSave with your target file as an argument: Just start FlickSave with your target file as an argument:
@ -55,7 +58,7 @@ If you want to see what's going on and when the snapshots are created, ask it to
$ kill 4303 $ kill 4303
[1]+ Complété ./flicksave.py -v INFO test.txt [1]+ Complété ./flicksave.py -v INFO test.txt
## Authors
Original Author: [![endorse](https://api.coderwall.com/nojhan/endorsecount.png)](https://coderwall.com/nojhan) # Authors
Original Author: nojhan ([![endorse](https://api.coderwall.com/nojhan/endorsecount.png)](https://coderwall.com/nojhan))