From 28188c3b371e54e734cbaf4e261cad34081ff93f Mon Sep 17 00:00:00 2001 From: undefined-landmark <74454337+undefined-landmark@users.noreply.github.com> Date: Thu, 1 Feb 2024 22:16:45 +0100 Subject: [PATCH] Add README_AUR.md (#783) --- README.md | 4 ++-- README_AUR.md | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+), 2 deletions(-) create mode 100644 README_AUR.md diff --git a/README.md b/README.md index 9e21de940..d91c5f8e2 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ - A command-line tool to download all your iCloud photos. - Works on Linux, Windows, and MacOS; laptop, desktop, and NAS -- Available as an executable for direct downloading and through package managers/ecosystems ([Docker](README_DOCKER.md), [PyPI](README_PYPI.md), Experimental: [Npm](README_NPM.md)) +- Available as an executable for direct downloading and through package managers/ecosystems ([Docker](README_DOCKER.md), [PyPI](README_PYPI.md), [AUR](README_AUR.md), Experimental: [Npm](README_NPM.md)) - Developed and maintained by volunteers (we are always looking for [help](CONTRIBUTING.md)). We aim to release new versions once a week (Friday), if there is something worth delivering. @@ -11,7 +11,7 @@ We aim to release new versions once a week (Friday), if there is something worth There are three ways to run `icloudpd`: 1. Download executable for your platform from the Github [Releases](https://github.com/icloud-photos-downloader/icloud_photos_downloader/releases) and run it -1. Use package manager to install, update, and, in some cases, run ([Docker](README_DOCKER.md), [PyPI](README_PYPI.md), [AUR](https://aur.archlinux.org/packages/icloudpd-bin), Experimental: [Npm](README_NPM.md)) +1. Use package manager to install, update, and, in some cases, run ([Docker](README_DOCKER.md), [PyPI](README_PYPI.md), [AUR](README_AUR.md), Experimental: [Npm](README_NPM.md)) 1. Build and run from the source ## Features diff --git a/README_AUR.md b/README_AUR.md new file mode 100644 index 000000000..af40f5f06 --- /dev/null +++ b/README_AUR.md @@ -0,0 +1,33 @@ +# iCloud Photos Downloader [![Quality Checks](https://github.com/icloud-photos-downloader/icloud_photos_downloader/workflows/Quality%20Checks/badge.svg)](https://github.com/icloud-photos-downloader/icloud_photos_downloader/actions/workflows/quality-checks.yml) [![Multi Platform Docker Build](https://github.com/icloud-photos-downloader/icloud_photos_downloader/workflows/Docker%20Build/badge.svg)](https://github.com/icloud-photos-downloader/icloud_photos_downloader/actions/workflows/docker-build.yml) [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md) + +A command-line tool to download all your iCloud photos. + +## Install + +AUR packages can be installed on Arch Linux. Installation can be done [manually](https://wiki.archlinux.org/title/Arch_User_Repository#Installing_and_upgrading_packages) or with the use of an [AUR helper](https://wiki.archlinux.org/title/AUR_helpers). + +The manual process would look like this: + +``` sh +git clone https://aur.archlinux.org/icloudpd-bin.git +cd icloudpd-bin +makepkg -sirc +``` + +With the use of the AUR helper e.g. [yay](https://github.com/Jguer/yay) the installation process would look like this: + +``` sh +yay -S icloudpd-bin +``` + +## Usage + +Synchronization logic can be adjusted with command-line parameters. Run the following to get full list: + +``` sh +icloudpd --help +``` + +## More + +See [Project page](https://github.com/icloud-photos-downloader/icloud_photos_downloader/) for more details.