From ce17acfc8049ac279b049a97657efced9ecd5862 Mon Sep 17 00:00:00 2001
From: Franco Masotti <franco.masotti@tutanota.com>
Date: Fri, 30 Jul 2021 16:10:05 +0200
Subject: [PATCH] Updated instructions.

---
 _pages/software.md | 37 ++++++++++++++++++++++++++++++-------
 1 file changed, 30 insertions(+), 7 deletions(-)

diff --git a/_pages/software.md b/_pages/software.md
index 435eac6..7bf0ec1 100644
--- a/_pages/software.md
+++ b/_pages/software.md
@@ -19,6 +19,8 @@ permalink: /software/
     - [Signing](#signing)
     - [Checksums](#checksums)
     - [Update the entry](#update-the-entry)
+    - [Create a new release file](#create-a-new-release-file)
+    - [Update the changelog](#update-the-changelog)
     - [Update the table of contents](#update-the-table-of-contents)
   - [Download](#download)
     - [Get the public key](#get-the-public-key)
@@ -97,6 +99,7 @@ The following extract is from a [post by Mike Gerwitz](https://mikegerwitz.com/2
 - `project`: the project name
 - `tag`: the git tag name which is usually [semver](https://semver.org/)ed
 - `signing_key`: the public key file used to sign the archive file
+- `changelog_slugified_header`: the slugified header corresponding to a tag in a changelog file
 - `url`: a generic url
 
 ## Methods
@@ -129,17 +132,37 @@ Go into the project directory and then:
 
 #### Update the entry
 
-Add the following to the head of the list:
+Create a new entry in this file
 
 ```
-- `${tag}`
-  - [${project}-${tag}.tar.gz]({{ site.baseurl }}/software/${project}-${tag}.tar.gz)
-  - [SHA512SUM.txt]({{ site.baseurl }}/software/${project}-${tag}.tar.gz.SHA512SUM.txt)
-  - [SHA256SUM.txt]({{ site.baseurl }}/software/${project}-${tag}.tar.gz.SHA256SUM.txt)
-  - [signature]({{ site.baseurl }}/software/${project}-${tag}.tar.gz.sig)
-  - [signing key]({{ site.baseurl }}/pubkeys/${signing_key})
+- [`${tag}`]({{ site.baseurl }}/software/${project}-${tag}/release.html)
 ```
 
+#### Create a new release file
+
+Create a new file called `${project}-${tag}/release.md` and add the following:
+
+```
+---
+layout: default
+title: release
+excerpt: none
+---
+
+# ${project}-${tag}
+
+- [CHANGELOG]({{ site.baseurl }}/software/CHANGELOG-${project}.html#${changelog_slugified_header})
+- [${project}-${tag}.tar.gz]({{ site.baseurl }}/software/${project}-${tag}.tar.gz)
+- [SHA512SUM.txt]({{ site.baseurl }}/software/${project}-${tag}.tar.gz.SHA512SUM.txt)
+- [SHA256SUM.txt]({{ site.baseurl }}/software/${project}-${tag}.tar.gz.SHA256SUM.txt)
+- [signature]({{ site.baseurl }}/software/${project}-${tag}.tar.gz.sig)
+- [signing key]({{ site.baseurl }}/pubkeys/${signing_key})
+```
+
+#### Update the changelog
+
+Update the changelog file at `CHANGELOG-${project}.md`
+
 #### Update the table of contents
 
     md_toc -p github -l 6 software.md