From c9d89ea21039beff7d37c473960f72b6bc9a556d Mon Sep 17 00:00:00 2001
From: Xerbo <xerbo@protonmail.com>
Date: Tue, 24 Jan 2023 18:16:18 +0000
Subject: [PATCH] Better naming

---
 .github/ISSUE_TEMPLATE/bug-report.md |  5 ++--
 .github/workflows/build.yml          | 24 ++++++++++----------
 UPGRADE_GUIDE.md                     | 34 ++++++++++++++++++++++++++++
 cmake/toolchain-mingw32.cmake        |  2 +-
 4 files changed, 49 insertions(+), 16 deletions(-)
 create mode 100644 UPGRADE_GUIDE.md

diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
index 41036f7..e85e0a7 100644
--- a/.github/ISSUE_TEMPLATE/bug-report.md
+++ b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -4,7 +4,6 @@ about: Create a bug report to improve aptdec
 title: ''
 labels: bug
 assignees: ''
-
 ---
 
 **Describe the bug**
@@ -17,7 +16,7 @@ Steps to reproduce the behavior.
 A clear description of what you expected to happen.
 
 **Link to audio**
-A link to the audio that caused the problem.
+A link to the audio file that caused the problem (if applicable).
 
 **Build information**
-The commit of aptdec you are running (check with `git rev-parse HEAD`), make sure it's up to date before opening this issue.
+The version of aptdec you are running (check with `git describe --tag`), make sure it's up to date before opening this issue.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index acbbe7b..a692a35 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -29,16 +29,16 @@ jobs:
     - name: Build and package
       run: cmake --build build -j$(nproc) && cmake --build build --target package
 
-    - name: Upload TGZ package
+    - name: Upload TGZ archive
       uses: actions/upload-artifact@v3
       with:
-          name: TGZ package
+          name: TGZ archive (x86_64/gcc)
           path: build/aptdec_*.tar.gz
 
-    - name: Upload DEB package
+    - name: Upload Debian package
       uses: actions/upload-artifact@v3
       with:
-          name: Debian package
+          name: Debian package (x86_64/gcc)
           path: build/aptdec_*.deb
 
   build_windows:
@@ -56,10 +56,10 @@ jobs:
     - name: Run build script
       run: ./build_windows.sh $BUILD_TYPE
 
-    - name: Upload ZIP package
+    - name: Upload ZIP archive
       uses: actions/upload-artifact@v3
       with:
-          name: ZIP package
+          name: ZIP archive (x86_64/MinGW)
           path: winbuild/aptdec_*.zip
   
   build_windows_msvc:
@@ -75,10 +75,10 @@ jobs:
       shell: cmd
       run: '"C:/Program Files/Microsoft Visual Studio/2022/Enterprise/VC/Auxiliary/Build/vcvars64.bat" & build_windows.bat'
 
-    - name: Upload ZIP package
+    - name: Upload ZIP archive
       uses: actions/upload-artifact@v3
       with:
-          name: ZIP package (MSVC)
+          name: ZIP archive (x86_64/MSVC)
           path: winbuild/aptdec_*.zip
   
   build_linux_armhf:
@@ -93,14 +93,14 @@ jobs:
     - name: Run build script
       run: docker run -v $(pwd):/aptdec:z -w /aptdec debian:11 ./build_arm.sh
 
-    - name: Upload DEB package
+    - name: Upload Debian package
       uses: actions/upload-artifact@v3
       with:
-          name: DEB package (ARM)
+          name: Debian package (armhf/gcc)
           path: build/aptdec_*.deb
 
-    - name: Upload TGZ package
+    - name: Upload TGZ archive
       uses: actions/upload-artifact@v3
       with:
-          name: TGZ package (ARM)
+          name: TGZ archive (armhf/gcc)
           path: build/aptdec_*.tar.gz
diff --git a/UPGRADE_GUIDE.md b/UPGRADE_GUIDE.md
new file mode 100644
index 0000000..0db0041
--- /dev/null
+++ b/UPGRADE_GUIDE.md
@@ -0,0 +1,34 @@
+# Upgrading from aptdec 1.8.0 to 2.0.0
+
+# `aptdec` (now `aptdec-cli`)
+
+## Removed
+
+- The `-d` (output directory) flag
+- The `-g` (gamma) flag
+- Map overlays/MCIR
+- Reading raw PNG images
+
+(Some of these features have been moved into `aptdec_post.py`)
+
+## Changes
+
+- "palettes" are now called "luts"
+- Image type and effects are now full English words (separated by commas) instead of letters
+- Output format of realtime images is now `CURRENT_TIME.png` instead of `CURRENT_TIME-r.png`
+- Channel A/B images include telemetry
+
+## Examples
+
+| v1.8                                  | v2.0.0                                    |
+|---------------------------------------|-------------------------------------------|
+| `aptdec file.wav`                     | `aptdec-cli file.wav`                     |
+| `aptdec -i rt file.wav`               | `aptdec-cli -i raw,thermal file.wav`      |
+| `aptdec -i ab file.wav`               | `aptdec-cli -i a,b -e strip file.wav`     |
+| `aptdec -i p -p palette.png file.wav` | `aptdec-cli -i lut -l lut.png file.wav`   |
+| `aptdec -d out *.wav`                 | `mkdir out; cd out; aptdec-cli ../*.wav`  |
+
+
+# `libapt` (now `libaptdec`)
+
+To avoid confusion with `apt` (the Debian package manager) the name of the aptdec library has been changed to `libaptdec`.
diff --git a/cmake/toolchain-mingw32.cmake b/cmake/toolchain-mingw32.cmake
index de03f7e..464fb89 100644
--- a/cmake/toolchain-mingw32.cmake
+++ b/cmake/toolchain-mingw32.cmake
@@ -1,6 +1,6 @@
 # the name of the target operating system
 SET(CMAKE_SYSTEM_NAME Windows)
-SET(CMAKE_SYSTEM_PROCESSOR amd64)
+SET(CMAKE_SYSTEM_PROCESSOR x86_64)
 
 # which compilers to use for C and C++
 SET(CMAKE_C_COMPILER x86_64-w64-mingw32-gcc)