Update changelog and release notes

This commit is contained in:
Veronica K. B. Olsen
2021-01-24 14:14:43 +01:00
parent 615804333e
commit 13f98e1675
3 changed files with 47 additions and 14 deletions
+27 -8
View File
@@ -4,6 +4,17 @@
### Release Notes
This patch release fixes a minor bug sometimes encountered when running novelWriter from command
line on Windows. In addition, the Solarized Dark and Solarized Light themes have been added to the
selection of GUI and syntax themes by a user contribution.
The main change in this release is to the install scripts and the documentation related to
installing and running novelWriter. The primary change is a different method of packaging the app
for Windows. Instead of building an `.exe` file, the new setup instead builds a runnable zip file
`.pyz`. The executable would often be mistakenly flagged by virus control software due to the
packaging tools. This is a known problem with pyinstaller and similar tools, but such warnings are
always concerning even if they are false positives.
### Detailed Changelog
**Bug Fixes**
@@ -15,27 +26,35 @@
**User Interface**
* Added Solarized Dark and Light GUI and syntax themes. PR #578 by @nullbasis.
* Added Solarized Dark and Solarized Light GUI and syntax themes. PR #578 by @nullbasis.
* The Typewriter Scroll Mode now works better in combination with the Scroll Past End feature. The
scroll mode still only works when there is actually any document to scroll, but previously it
would also not work until the total length of the document reached 40% of the height of the
editor window. This was quite confusing. This limit is now reduced to 10%. Issue #589, PR #593.
scroll mode still only works when there is actually any document to scroll into, but previously
it would also not work until the total length of the document reached 40% of the height of the
editor window. This was quite confusing. This limit is now reduced to 10%, which means that as
long as the Scroll Past End option is enabled, the Typewriter Scroll will always work according
to its settings. Issue #589, PR #593.
**Installation**
* Merged the `make.py` script into `setup.py`. PR #584.
* Added a second way to build distributable packages of novelWriter for Windows. The new method
does not use any of the current package tools that produce a Windows executable of the app. These
packages tend to cause false virus warnings. This method uses the Python tool `zipapp` to bundle
novelWriter as an executable `.pyz` file, and adds Python embeddable and library dependencies
into the same folder. The folder itself can be distributed as-is, or a Windows installer
executable can be generated with `setup.py setup-pyz`. Issue #580, PR #584.
packages tend to cause false virus warnings. This new method uses the Python tool `zipapp` to
bundle novelWriter as an executable `.pyz` file, and adds Python embeddable and library
dependencies into the same folder. The folder itself can be distributed as-is, or a Windows
installer executable can be generated with `setup.py setup-pyz`. Issue #580, PR #584.
**Documentation**
* Updated documentation, main README and Contribution Guide to make them more consistent and to
improve installation instructions. Based on issue #586 and input from @mgrhm. PR #592.
**Other CHanges**
* The HTML generator now adds line breaks after `div` blocks used to wrap tag/reference lines. This
makes the output easier to process by scripts, but has no impact on browser rendering and import
into other applications. PR #597.
----
## Version 1.0.2 [2021-01-19]
+17 -3
View File
@@ -2,15 +2,29 @@
<html>
<body>
<h2>Release Notes for 1.0.3</h2>
<p><i>Released on 24 January 2021</i></p>
<p>This patch release fixes a minor bug sometimes encountered when running novelWriter from command
line on Windows. In addition, the Solarized Dark and Solarized Light themes have been added to the
selection of GUI and syntax themes by a user contribution.</p>
<p>The main change in this release is to the install scripts and the documentation related to
installing and running novelWriter. The primary change is a different method of packaging the app
for Windows. Instead of building an <i>.exe</i> file, the new setup instead builds a runnable zip
file <i>.pyz</i>. The executable would often be mistakenly flagged by virus control software due to
the packaging tools. This is a known problem with pyinstaller and similar tools, but such warnings
are always concerning even if they are false positives.</p>
<p><i>The full changelog is available
<a href="https://github.com/vkbo/novelWriter/blob/main/CHANGELOG.md">here</a>.</i></p>
<hr/>
<h2>Release Notes for 1.0.2</h2>
<p><i>Released on 19 January 2021</i></p>
<p>This patch release fixes a few minor cosmetic issues, a minor issue with the indexer, and a bug
when adding words to the user's own spell check dictionary. Additionally, the documentation has
been updated based on user feedback, and some install issues resolved.</p>
<p><i>The full changelog is available
<a href="https://github.com/vkbo/novelWriter/blob/main/CHANGELOG.md">here</a>.</i></p>
<hr/>
<h2>Release Notes for 1.0.1</h2>
+3 -3
View File
@@ -1,13 +1,13 @@
<?xml version='1.0' encoding='utf-8'?>
<novelWriterXML appVersion="1.0.2" hexVersion="0x010002f0" fileVersion="1.2" timeStamp="2021-01-19 20:55:33">
<novelWriterXML appVersion="1.0.3" hexVersion="0x010003f0" fileVersion="1.2" timeStamp="2021-01-24 14:14:09">
<project>
<name>Sample Project</name>
<title>Sample Project</title>
<author>Jane Smith</author>
<author>Jay Doh</author>
<saveCount>826</saveCount>
<saveCount>830</saveCount>
<autoCount>153</autoCount>
<editTime>39506</editTime>
<editTime>39583</editTime>
</project>
<settings>
<doBackup>False</doBackup>