Update project README

README.md

@@ -1,26 +1,69 @@
-# Instrumental Music Collection
+<div align="center">
+    <img src="extra/icon.svg" alt="NCH Logo" width="64" height="64">
+    <div>
+        <br>
+        <code>201.001</code>
+    </div>
+    <h1 align="center">Instrumental Music Collection</h1>
+</div>
+
+<div align="center">
+    <p>
+        <a align="center" href="https://git.ami.sc/ami/instrumental-music-collection">
+            <img height="16" width="16" src="https://cdn.simpleicons.org/git/00B8FF/00B8FF"/>
+            &nbsp;Starlane
+        </a>
+        &emsp;
+        <a align="center" href="https://github.com">
+            <img height="16" width="16" src="https://cdn.simpleicons.org/github/00B8FF/00B8FF"/>
+            &nbsp;GitHub
+        </a>
+    </p>
+</div>
+
+<img height="4" width="100%" src="extra/gradient.png"/>
 
 ## 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
+```bash
-make all -j 14
+conda activate IMS
 ```
 
-To install the encoded files to a target location, run:
+Then, run the processing pipeline with:
 
-```sh
+```bash
-make install INSTALL_DIR=/path/to/dir
+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
 ```

extra/icon.svg

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="256" height="256" version="1.1"
+     xmlns="http://www.w3.org/2000/svg"
+     xmlns:xlink="http://www.w3.org/1999/xlink">
+  <defs>
+    <linearGradient id="Gradient" x1="0" x2="0" y1="0" y2="1">
+      <stop offset="0%" style="stop-color:#1A5FB4;stop-opacity:1" />
+      <stop offset="100%" style="stop-color:#8FF0A4;stop-opacity:1" />
+    </linearGradient>
+    <filter id="alpha-to-white">
+      <feColorMatrix in="SourceGraphic" type="matrix"
+                     values="0 0 0 0 1 0 0 0 0 1 0 0 0 0 1 0 0 0 1 0"/>
+    </filter>
+    <g id="child-svg"><svg xmlns="http://www.w3.org/2000/svg" height="16" width="16" viewBox="0 0 512 512"><path opacity="1" fill="#1E3050" d="M499.1 6.3c8.1 6 12.9 15.6 12.9 25.7v72V368c0 44.2-43 80-96 80s-96-35.8-96-80s43-80 96-80c11.2 0 22 1.6 32 4.6V147L192 223.8V432c0 44.2-43 80-96 80s-96-35.8-96-80s43-80 96-80c11.2 0 22 1.6 32 4.6V200 128c0-14.1 9.3-26.6 22.8-30.7l320-96c9.7-2.9 20.2-1.1 28.3 5z" /></svg></g>
+  </defs>
+  <rect
+      width="256"
+      height="256"
+      fill="url(#Gradient)"
+      ry="128"
+      x="0"
+      y="0" />
+  <use xlink:href="#child-svg" filter="url(#alpha-to-white)"
+       transform="matrix(8,0,0,8,64,64)" />
+</svg>