From 3536e0adba5ebee8271e19a9ef3494de444edd0f Mon Sep 17 00:00:00 2001 From: Francesco Esposito <33671357+frab1t@users.noreply.github.com> Date: Thu, 11 Apr 2019 00:30:53 +0200 Subject: [PATCH] Edit readme --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0ed9d8f..6510102 100644 --- a/README.md +++ b/README.md @@ -1 +1,25 @@ -# rsync-linux-home \ No newline at end of file +# rsync-linux-home + +A simple script to make backups of your linux home. + +## Usage +1. Configure UUID of destination partition into `rsync-linux-home.py`: + ``` + DRIVE_UUID="" + ``` + +2. Configure which folders to include and which to exclude, changing arrays `INCLUDES`/`EXCLUDES` into `rsync-linux-home.py`: + ``` + INCLUDES = [...] + EXCLOUDES = [...] + ``` + +3. Make the script executable + ``` + chmod +x rsync-linux-home.py + ``` + +4. Launch the script to perform the backup + ``` + ./rsync-linux-home.py + ``` \ No newline at end of file