diff --git a/README.md b/README.md index f68bce1..a6defc4 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,8 @@ such as year taken and camera make. ## Getting started +For detailed instructions: [link](USERGUIDE.md) + **Install prerequisites:** - Java 17 or later diff --git a/USERGUIDE.md b/USERGUIDE.md new file mode 100644 index 0000000..87ba675 --- /dev/null +++ b/USERGUIDE.md @@ -0,0 +1,52 @@ +# User guide + +Here's an extended version of content from the [general README](README.md). + +## General setup + +If you have not built the application yet, please follow the general README +to get started first. + +### Dropbox setup + +Set mode to `DROPBOX` in `Main.java` + +Dropbox step 1 + +Configure Dropbox credentials in `config.properties` + +Dropbox step 2 + +### Google Drive setup + +Set mode to `GOOGLE_DRIVE` in `Main.java` + +Drive step 1 + +Configure Google Drive credentials in `config.properties` + +Drive step 2 + +## Run migration + +- Open your terminal and navigate to the `./photohaul` directory +- Run the command `gradle run`. This will start the migration to Google Drive + +Migration step + +## Validate migration + +Once the migration is complete, you can verify that your photos have been uploaded +to Google Drive. Here's an example of how I validate the output for Google Drive. + +Folder creation + +Validate step 1 + +Photo creation in 2015 + +Validate step 2 + +Photo creation in 2024 + +Validate step 3 diff --git a/images/dbx-step-1.png b/images/dbx-step-1.png new file mode 100644 index 0000000..3f35f5a Binary files /dev/null and b/images/dbx-step-1.png differ diff --git a/images/dbx-step-2.png b/images/dbx-step-2.png new file mode 100644 index 0000000..82a41be Binary files /dev/null and b/images/dbx-step-2.png differ diff --git a/images/drive-step-1.png b/images/drive-step-1.png new file mode 100644 index 0000000..6f54da6 Binary files /dev/null and b/images/drive-step-1.png differ diff --git a/images/drive-step-2.png b/images/drive-step-2.png new file mode 100644 index 0000000..a4926f9 Binary files /dev/null and b/images/drive-step-2.png differ diff --git a/images/migration-step.png b/images/migration-step.png new file mode 100644 index 0000000..f021a9a Binary files /dev/null and b/images/migration-step.png differ diff --git a/images/validate-step-1.png b/images/validate-step-1.png new file mode 100644 index 0000000..c82f72d Binary files /dev/null and b/images/validate-step-1.png differ diff --git a/images/validate-step-2.png b/images/validate-step-2.png new file mode 100644 index 0000000..35a89fd Binary files /dev/null and b/images/validate-step-2.png differ diff --git a/images/validate-step-3.png b/images/validate-step-3.png new file mode 100644 index 0000000..ff9e9f7 Binary files /dev/null and b/images/validate-step-3.png differ