From bef943ffa2751e7c5b6f8398eee8205d3b4e47bd Mon Sep 17 00:00:00 2001 From: Andrey Nikiforov Date: Sun, 16 Jun 2024 11:57:47 -0700 Subject: [PATCH] ref doc from readme's (#870) --- README.md | 10 +++++++--- docs/conf.py | 2 +- docs/install.md | 2 +- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 37100eefb..8d27d337e 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,22 @@ - 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), [AUR](README_AUR.md), [Npm](README_NPM.md)) +- Available as an executable for direct downloading and through package managers/ecosystems ([Docker](https://icloud-photos-downloader.github.io/icloud_photos_downloader/install.html#docker), [PyPI](https://icloud-photos-downloader.github.io/icloud_photos_downloader/install.html#pypi), [AUR](https://icloud-photos-downloader.github.io/icloud_photos_downloader/install.html#aur), [Npm](https://icloud-photos-downloader.github.io/icloud_photos_downloader/install.html#npm)) - Developed and maintained by volunteers (we are always looking for [help](CONTRIBUTING.md)). +See [Documentation](https://icloud-photos-downloader.github.io/icloud_photos_downloader/) for more details + We aim to release new versions once a week (Friday), if there is something worth delivering. ## Install and Run 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](README_AUR.md), [Npm](README_NPM.md)) +1. Download executable for your platform from the Github [Release](https://github.com/icloud-photos-downloader/icloud_photos_downloader/releases/tag/v1.19.1) and run it +1. Use package manager to install, update, and, in some cases, run ([Docker](https://icloud-photos-downloader.github.io/icloud_photos_downloader/install.html#docker), [PyPI](https://icloud-photos-downloader.github.io/icloud_photos_downloader/install.html#pypi), [AUR](https://icloud-photos-downloader.github.io/icloud_photos_downloader/install.html#aur), [Npm](https://icloud-photos-downloader.github.io/icloud_photos_downloader/install.html#npm)) 1. Build and run from the source +See [Documentation](https://icloud-photos-downloader.github.io/icloud_photos_downloader/install.html) for more details + ## Features diff --git a/docs/conf.py b/docs/conf.py index dae6d4ebf..c374cded5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,7 +19,7 @@ templates_path = ['_templates'] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] -html_title = "icloudpd" +html_title = "icloudpd 1.19.1" language = "en" # language = 'Python' diff --git a/docs/install.md b/docs/install.md index 6fb281718..d637587e2 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,7 +1,7 @@ # Install and Run 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. Download executable for your platform from the Github [Release](https://github.com/icloud-photos-downloader/icloud_photos_downloader/releases/tag/v1.19.1) and run it 1. Use package manager to install, update, and, in some cases, run ([Docker](#docker), [PyPI](#pypi), [AUR](#aur), [Npm](#npm)) 1. Build and run from the source