Merge branch 'main' into testing

This commit is contained in:
Veronica K. B. Olsen
2021-03-21 17:18:29 +01:00
4 changed files with 83 additions and 17 deletions
+27
View File
@@ -1,5 +1,32 @@
# novelWriter Changelog
## Version 1.2.1 [2021-03-21]
### Release Notes
This patch release is a bug fix release addressing issues with the document editor's search and
replace tool. Due to some recently added restrictions on when various tools are active, depending
on which part of the main window has the user's focus, the search tool keyboard shortcuts and
buttons were blocked when they shouldn't. This release resolves these issues.
### Detailed Changelog
**Bugfixes**
* Fixed an issue with the search bar where the button and shortcut actions would be blocked unless
the document itself had focus. This focus check was added for all the text altering functions,
but should not affect search and replace. The search and replace actions now bypass the regular
action pipeline with the focus check. Issue #708. PR #709.
**Documentation**
* Improve the instructions for setup on Linux when manually installing using the `setup.py` script.
Previously, the documentation wasn't very clear on the difference between a user space install
and a system wide install. Neither did it explain how to install `setuptools` if the package is
missing. Issue #714. PR #715.
----
## Version 1.2 [2021-03-14]
### Release Notes
+32 -10
View File
@@ -42,34 +42,56 @@ can install them with:
Step 2: Install Package (Optional)
----------------------------------
You can install novelWriter to the correct location for Python packages with:
You can install novelWriter to the default location for Python packages using ``setuptools``. This
step is optional as you can also just put the novelWriter program folder wherever you like. For
instance to ``/opt/novelWriter`` and run Step 3 to set up icons and launcher.
To install novelWriter to the default location, it requires that you have ``setuptools`` installed
on your system. If you don't have it installed, it can usually be installed from your distro's
repository. For Debian and Ubuntu this is achieved with:
.. code-block:: console
./setup.py install
sudo apt install python3-setuptools
The package is also available from PyPi:
.. code-block:: console
pip3 install --user setuptools
With ``setuptools`` in place, novelWriter can be installed to the user space with:
.. code-block:: console
./setup.py install --user
This should install novelWriter as ``~/.local/bin/novelWriter``. If you instead want to install for
all users, i.e. as ``/usr/local/bin/novelWriter``, run:
.. code-block:: console
sudo ./setup.py install
This is equivalent to what the ``pip`` installer does. It puts novelWriter in the location on your
system where Python packages are usually kept. This is not really the best suited location for a
GUI application like novelWriter, so you may instead copy the entire source to a suiteable location
yourself.
This should install novelWriter to either ``~/.local/bin/novelWriter`` if installed for local user
only, or to ``/usr/local/bin/novelWriter`` if installed for all users (with the ``sudo`` command).
Step 3: Create Launcher Icons
-----------------------------
Regardless of where you extract or install the source files, you can easily set up a standard icon
and launcher. To set up this desktop launcher, the needed icons, and the project file association,
run:
Regardless of where you extract or install the source files, you can set up a standard icon and a
launcher. To set up this desktop launcher, the needed icons, and the project file association,
run the following from inside the novelWriter folder:
.. code-block:: console
./setup.py xdg-install
By default, these commands install novelWriter and its icons for the current user only. To install
for all users, run the script with the ``sudo`` command.
By default, this command installs the launcher and icons for the current user only. To install for
all users, run the script with the ``sudo`` command.
.. tip::
All options of the setup script can be listed with: ``./setup.py help``.
+12 -5
View File
@@ -52,12 +52,19 @@ You can install novelWriter to the correct location for Python packages with:
.. code-block:: console
./setup.py install
./setup.py install --user
This is equivalent to what the ``pip`` installer does. It puts novelWriter in the location on your
system where Python packages are usually kept. This is not really the best suited location for a
GUI application like novelWriter, so you may instead copy the entire source to a suiteable location
yourself.
This requires that the package ``setuptools`` is installed on your system. If not, it can be
installed with:
.. code-block:: console
pip3 install --user setuptools
This is method of install is equivalent to what the ``pip`` installer does. It puts novelWriter in
the location on your system where Python packages are usually kept. This is not really the best
suited location for a GUI application like novelWriter, so you may instead copy the entire source
to a suiteable location yourself.
After this, you should be able to launch novelWriter by running ``novelWriter`` in a command line
window.
+12 -2
View File
@@ -2,6 +2,18 @@
<html>
<body>
<h2>Release Notes for 1.2.1</h2>
<p><i>Released on 21 March 2021</i></p>
<p>This patch release is a bug fix release addressing issues with the document editor's search and
replace tool. Due to some recently added restrictions on when various tools are active, depending
on which part of the main window has the user's focus, the search tool keyboard shortcuts and
buttons were blocked when they shouldn't. This release resolves these issues.</p>
<p><i>See also the <a href="https://github.com/vkbo/novelWriter/releases">Releases</a> page.</i></p>
<hr/>
<h2>Release Notes for 1.2</h2>
<p><i>Released on 14 March 2021</i></p>
<p>This release is mainly focused on the Build Novel Project tool. Completely new export classes
@@ -79,7 +91,5 @@ indexer now checks that a keyword (tag or reference) is valid before saving it t
Previously, an invalid keyword could be saved to the index and potentially crash the application.
</p>
<p><i>See also the <a href="https://github.com/vkbo/novelWriter/releases">Releases</a> page.</i></p>
</body>
</html>