From b8b7a843215f7c899f0af5532941d8a921a8aa0a Mon Sep 17 00:00:00 2001 From: nojhan Date: Wed, 29 Nov 2017 21:22:26 +0100 Subject: [PATCH] fix README markdown --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9a8a10b..a2c524f 100644 --- a/README.md +++ b/README.md @@ -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, along with the precise date of this version. -## 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 +## 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: .) @@ -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: _) * `-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) -## Examples -### Command line + +# Examples + +## Command line 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 [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))