Skip to content

Commit

Permalink
Add README_AUR.md (#783)
Browse files Browse the repository at this point in the history
  • Loading branch information
undefined-landmark authored Feb 1, 2024
1 parent a5b3f0e commit 28188c3
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
33 changes: 33 additions & 0 deletions README_AUR.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 28188c3

Please sign in to comment.