diff --git a/README.md b/README.md index 1ad3264..47db510 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,69 @@ -# Instrumental Music Collection +
+ NCH Logo +
+
+ 201.001 +
+

Instrumental Music Collection

+
+ +
+

+ + +  Starlane + +   + + +  GitHub + +

+
+ + ## Description -This repository contains scripts to automate encoding and metadata management of instrumental tracks. +A collection of scripts to encode and tag my personal instrumental music collection. ## Requirements -The project depends on the following: +System dependencies: +- `make` +- `rsync` - `ffmpeg` - `metaflac` +This project is managed through a `conda` environment. To install the required dependencies, run the following: + +```bash +conda env create -f environment.yml +``` + ## Running -To encode all files to `.flac` and write metadata, run: +First, activate the `conda` environment: -```sh -make all -j 14 +```bash +conda activate IMS ``` -To install the encoded files to a target location, run: +Then, run the processing pipeline with: -```sh -make install INSTALL_DIR=/path/to/dir +```bash +make all -j $(nproc) \ + SSH_LOCATION=user@location \ + CELLAR_BOTTLE=/path/to/bottle \ + PROJECT_ID=201.001 \ + INSTALL_DIR=/path/to/install/dir +``` + +The finalized collection will be installed to the specified `INSTALL_DIR`. + +To clean up the working directories, run: + +```bash +make clean ``` diff --git a/extra/gradient.png b/extra/gradient.png new file mode 100644 index 0000000..edece44 Binary files /dev/null and b/extra/gradient.png differ diff --git a/extra/icon.svg b/extra/icon.svg new file mode 100644 index 0000000..08445d1 --- /dev/null +++ b/extra/icon.svg @@ -0,0 +1,25 @@ + + + + + + + + + + + + + + +