Update docs
parent
9e0398ba8f
commit
490be27b34
5
Makefile
5
Makefile
|
@ -1,7 +1,10 @@
|
||||||
all: dev-setup lint build-js-production test
|
all: dev-setup lint build-js-production test
|
||||||
|
|
||||||
# Dev env management
|
# Dev env management
|
||||||
dev-setup: clean clean-dev npm-init
|
dev-setup: clean clean-dev npm-init get-exiftool
|
||||||
|
|
||||||
|
get-exiftool:
|
||||||
|
./get-exiftool.sh
|
||||||
|
|
||||||
npm-init:
|
npm-init:
|
||||||
npm ci
|
npm ci
|
||||||
|
|
14
README.md
14
README.md
|
@ -21,26 +21,16 @@ Memories is a photo management app for Nextcloud with advanced features includin
|
||||||
|
|
||||||
## 🚀 Installation
|
## 🚀 Installation
|
||||||
|
|
||||||
1. Install the app from the Nextcloud app store
|
1. Install the app from the Nextcloud app store.
|
||||||
1. ⚒️ Install `exiftool` (see below).
|
|
||||||
1. Run `php ./occ memories:index` to generate metadata indices for existing photos.
|
1. Run `php ./occ memories:index` to generate metadata indices for existing photos.
|
||||||
1. Open the 📷 Memories app in Nextcloud and set the directory containing your photos. Photos from this directory will be displayed in the timeline, including any photos in nested subdirectories.
|
1. Open the 📷 Memories app in Nextcloud and set the directory containing your photos. Photos from this directory will be displayed in the timeline, including any photos in nested subdirectories.
|
||||||
1. Installing the [preview generator](https://github.com/rullzer/previewgenerator) for pre-generating thumbnails is strongly recommended.
|
1. Installing the [preview generator](https://github.com/rullzer/previewgenerator) for pre-generating thumbnails is strongly recommended.
|
||||||
|
|
||||||
## 🔨 Installing Dependencies
|
|
||||||
The exact steps depend on your Nextcloud platform. If you use Docker for your Nextcloud instance, you can install Exiftool by using a custom docker image.
|
|
||||||
- **Ubuntu/Debian**: `sudo apt install libimage-exiftool-perl`
|
|
||||||
- **Fedora**: `sudo dnf install perl-Image-ExifTool`
|
|
||||||
- **Arch Linux**: `sudo pacman -S perl-image-exiftool`
|
|
||||||
- **Alpine**: `apk add --no-cache exiftool`
|
|
||||||
- **MacOS**: `brew install exiftool`
|
|
||||||
- **FreeBSD**: `sudo pkg install p5-Image-ExifTool`
|
|
||||||
|
|
||||||
## 🏗 Development setup
|
## 🏗 Development setup
|
||||||
|
|
||||||
1. ☁ Clone this into your `apps` folder of your Nextcloud.
|
1. ☁ Clone this into your `apps` folder of your Nextcloud.
|
||||||
1. 👩💻 In a terminal, run the command `make dev-setup` to install the dependencies.
|
1. 👩💻 In a terminal, run the command `make dev-setup` to install the dependencies.
|
||||||
1. 🏗 Then to build the Javascript whenever you make changes, run `make build-js`. To create a pull request use `make build-js-production`. Watch changes with: `make watch-js`.
|
1. 🏗 Then to build the Typescript whenever you make changes, run `make build-js`. Watch changes with: `make watch-js`.
|
||||||
1. ✅ Enable the app through the app management of your Nextcloud.
|
1. ✅ Enable the app through the app management of your Nextcloud.
|
||||||
1. 🎉 Partytime!
|
1. 🎉 Partytime!
|
||||||
|
|
||||||
|
|
|
@ -22,19 +22,9 @@ Memories is a photo management app for Nextcloud with advanced features includin
|
||||||
## 🚀 Installation
|
## 🚀 Installation
|
||||||
|
|
||||||
1. Install the app from the Nextcloud app store
|
1. Install the app from the Nextcloud app store
|
||||||
1. ⚒️ Install `exiftool` (see below).
|
|
||||||
1. Run `php ./occ memories:index` to generate metadata indices for existing photos.
|
1. Run `php ./occ memories:index` to generate metadata indices for existing photos.
|
||||||
1. Open the 📷 Memories app in Nextcloud and set the directory containing your photos. Photos from this directory will be displayed in the timeline, including any photos in nested subdirectories.
|
1. Open the 📷 Memories app in Nextcloud and set the directory containing your photos. Photos from this directory will be displayed in the timeline, including any photos in nested subdirectories.
|
||||||
1. Installing the [preview generator](https://github.com/rullzer/previewgenerator) for pre-generating thumbnails is strongly recommended.
|
1. Installing the [preview generator](https://github.com/rullzer/previewgenerator) for pre-generating thumbnails is strongly recommended.
|
||||||
|
|
||||||
## 🔨 Installing Dependencies
|
|
||||||
The exact steps depend on your Nextcloud platform. If you use Docker for your Nextcloud instance, you can install Exiftool by using a custom docker image.
|
|
||||||
- **Ubuntu/Debian**: `sudo apt install libimage-exiftool-perl`
|
|
||||||
- **Fedora**: `sudo dnf install perl-Image-ExifTool`
|
|
||||||
- **Arch Linux**: `sudo pacman -S perl-image-exiftool`
|
|
||||||
- **Alpine**: `apk add --no-cache exiftool`
|
|
||||||
- **MacOS**: `brew install exiftool`
|
|
||||||
- **FreeBSD**: `sudo pkg install p5-Image-ExifTool`
|
|
||||||
]]></description>
|
]]></description>
|
||||||
<version>4.3.0-beta.1</version>
|
<version>4.3.0-beta.1</version>
|
||||||
<licence>agpl</licence>
|
<licence>agpl</licence>
|
||||||
|
|
Loading…
Reference in New Issue