changeset 7:4ac3fcff5a81

Add install/use instructions to README
author Lewin Bormann <lbo@spheniscida.de>
date Fri, 14 Jun 2019 21:37:40 +0200
parents 173a94e88057
children d29a31694736
files README.md
diffstat 1 files changed, 13 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Fri Jun 14 21:30:58 2019 +0200
+++ b/README.md	Fri Jun 14 21:37:40 2019 +0200
@@ -1,6 +1,6 @@
 # photosync
 
-Now that Google deprecates the Photos<->Drive synchronization, I need another way to back up my photos locally. This
+Now that Google deprecates the Photos<-\>Drive synchronization, I need another way to back up my photos locally. This
 program downloads all photos from your Google Photos account and organizes them locally. It is not very user friendly
 yet, but definitely usable.
 
@@ -15,3 +15,15 @@
 mapping photos to directories.
 
 Albums are currently ignored.
+
+## Install & Use
+
+1. Clone this repository to a convenient place: `git clone https://github.com/dermesser/photosync` or `hg clone
+   git+https://github.com/dermesser/photosync`.
+1. Install `pipenv`: `pip3 install pipenv` if not yet installed.
+1. Go into the `photosync` repository and run `pipenv install` (make sure that `~/.local/bin/pipenv` is in your `PATH`)
+1. Activate the virtualenv: `pipenv shell` (sigh)
+1. Run it: `python3 photosync.py --help`
+
+Consult the help text printed by the last command. Usually you will need to set `--dir` so that your photos don't end up
+in the repository.