Update Appdata XML and add screenshot (#2229)

vkbo · Feb 5, 2025 · 589bc7c · 589bc7c
1 parent 85b953b
commit 589bc7c
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 25 deletions.
diff --git a/setup/novelwriter.appdata.xml b/setup/novelwriter.appdata.xml
@@ -1,21 +1,23 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <component type="desktop-application">
-	<id>novelwriter</id>
-	<metadata_license>GPL-3.0</metadata_license>
-	<project_license>GPL-3.0</project_license>
-	<name>novelWriter</name>
-	<summary>A markdown-like text editor for planning and writing novels</summary>
-	<description>
-		<p>{description}</p>
-	</description>
-	<launchable type="desktop-id">novelwriter.desktop</launchable>
-	<url type="homepage">https://novelwriter.io/</url>
-	<screenshots>
-		<screenshot type="default">
-			<image>https://novelwriter.io/images/screenshot-multi.png</image>
-		</screenshot>
-	</screenshots>
-	<provides>
-		<id>novelwriter.desktop</id>
-	</provides>
-</component>
+  <id>io.novelwriter.novelWriter</id>
+  <metadata_license>GPL-3.0</metadata_license>
+  <project_license>GPL-3.0</project_license>
+  <developer_name>Veronica Berglyd Olsen</developer_name>
+  <name>novelWriter</name>
+  <summary>A plain text editor for planning and writing novels</summary>
+  <description>
+    <p>{description}</p>
+  </description>
+  <launchable type="desktop-id">novelwriter.desktop</launchable>
+  <url type="homepage">https://novelwriter.io/</url>
+  <screenshots>
+    <screenshot type="default">
+      <image>https://raw.githubusercontent.com/vkbo/novelWriter/refs/heads/main/setup/screenshot.png</image>
+    </screenshot>
+  </screenshots>
+  <provides>
+    <mediatype>application/x-novelwriter-project</mediatype>
+    <id>novelwriter.desktop</id>
+  </provides>
+</component>
diff --git a/setup/screenshot.png b/setup/screenshot.png
diff --git a/utils/build_appimage.py b/utils/build_appimage.py
@@ -27,8 +27,8 @@
 import sys
 
 from utils.common import (
-    ROOT_DIR, SETUP_DIR, copyPackageFiles, copySourceCode, extractVersion,
-    makeCheckSum, readFile, toUpload, writeFile
+    ROOT_DIR, SETUP_DIR, appdataXml, copyPackageFiles, copySourceCode,
+    extractVersion, makeCheckSum, toUpload, writeFile
 )
 
 
@@ -113,10 +113,7 @@ def appImage(args: argparse.Namespace) -> None:
     # Write Metadata
     # ==============
 
-    appDescription = readFile(SETUP_DIR / "description_short.txt")
-    appdataXML = readFile(SETUP_DIR / "novelwriter.appdata.xml")
-    appdataXML = appdataXML.format(description=appDescription)
-    writeFile(imgDir / "novelwriter.appdata.xml", appdataXML)
+    writeFile(imgDir / "novelwriter.appdata.xml", appdataXml())
     print("Wrote:  novelwriter.appdata.xml")
 
     writeFile(imgDir / "entrypoint.sh", (

diff --git a/utils/common.py b/utils/common.py
@@ -172,6 +172,15 @@ def checkAssetsExist() -> bool:
     return hasSample and hasManual and hasQmData
 
 
+def appdataXml() -> str:
+    """Generate the appdata XML content."""
+    raw = readFile(SETUP_DIR / "description_short.txt")
+    desc = " ".join(raw.strip().splitlines()).strip()
+    xml = readFile(SETUP_DIR / "novelwriter.appdata.xml")
+    xml = xml.format(description=desc)
+    return xml
+
+
 def readFile(file: Path) -> str:
     """Read an entire file and return as a string."""
     return file.read_text(encoding="utf-8")