Updated readme and changelog

This commit is contained in:
Veronica K. B. Olsen
2021-02-03 19:38:34 +01:00
parent 247e51478b
commit c0dee497cd
2 changed files with 26 additions and 14 deletions
+18 -10
View File
@@ -4,36 +4,44 @@
### Release Notes
This patch release fixes a couple of minor issues with the Preferences dialog and the behaviour of
one of the keyboard shortcuts.
Aside from these fixes, the main point of this patch is to add new setup features for novelWriter
on Windows. A Windows installer will no longer be provided for the foreseeable future, and instead
functionality has been added to the main setup script to create desktop and start menu icons.
### Detailed Changelog
**Bug Fixes**
* Fixed an issue where the setting for justified text in the text editor was in the Preferences
dialog mixed with the setting for fixed text width in the editor. This meant that the justified
text setting could potentially get overridden when the Preferences dialog was used. Issue #623,
PR #625.
* Fixed an issue with the Preferences dialog where the setting for justified text was mixed with
the setting for fixed text width. This meant that the justified text setting could potentially
get overwritten when the Preferences were changed and saved. Issue #623, PR #625.
* Fixed an issue with the Open Project dialog where the list of recent projects would contain
duplicate entries if the dialog was opened multiple times. PR #627.
**User Interface**
* The `Ctrl+Del` keyboard shortcut is now only active when the project tree has focus. Since this
is also a common used shortcut in many application for deleting the next word, the deletion of a
file when the key combination is used in the editor is unexpected. Issue #629, PR #631.
is also a common shortcut in many applications for deleting the next word ahead of the cursor,
the activation of the delete file function when the editor has focus is unexpected to some users.
Issue #629, PR #631.
**Installation**
* A new command has been added to the `setup.py` script. The new command, `win-install`, will
create a desktop and start menu icon for novelWriter when run in the source folder. A windows
batch file, `win_install.bat`, has also been added. Running this file from the source folder,
batch file, `setup_windows.bat`, has also been added. Running this file from the source folder,
either by command line or by double-click, will install dependencies from PyPi and set up the
icons. This should make it easier to run novelWriter from the source folder on Windows. PR #634.
icons and file association with novelWriter project files. This should make it easier to run
novelWriter from the source folder on Windows. PRs #634 and #641.
**Documentation**
* The documentation on how to setup and install novelWriter has been extended and reorganised into
one file per operating system. Some of the other documentation files have also been moved to a
new section. PR #634.
different section. PR #634.
----
@@ -917,7 +925,7 @@ planned by GitHub. See their [notes](https://github.com/github/renaming) for mor
**Other Changes**
* The install scripts now try to create folders before copying icons. PR #364.
* The manifest file now lists the root assets folder, so that it is included in the pypi build. PR
* The manifest file now lists the root assets folder, so that it is included in the PyPi build. PR
#364.
* The .desktop template file has the correct categories set according to the FreeDesktop standard.
PR #364.
+8 -4
View File
@@ -191,9 +191,13 @@ novelWriter
### Setup on Windows
For Windows, you can either install via PyPi, or use the Windows installer available from the
[releases](https://github.com/vkbo/novelWriter/releases) page. This should add the necessary icons
to your desktop and start menu.
For Windows, first ensure that you have Python installed. If not, get it from
[python.org/downloads](https://www.python.org/downloads/). Remember to select "Add Python to PATH"
during the installation, otherwise novelWriter cannot find it.
Then, download the `Source code` zip file from the Release page, extract it to wherever you want to
keep novelWriter on your PC, and run the `setup_windows.bat` file in it. This will install the
necessary dependencies from [pypi,org](https://pypi.org/) and create desktop and start menu icons.
## Debugging
@@ -211,7 +215,7 @@ details, or consult the [LICENSE](https://github.com/vkbo/novelWriter/blob/main/
Bundled assets have the following licenses:
* The Typicon-based icon themes by Stephen Hutchings are licensed under
* The Typicons-based icon themes by Stephen Hutchings are licensed under
[CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/). The icons have been altered in
size and colour for use with novelWriter, and some additional icons added. The original icon set
is available at