Reproog/novelWriter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Further clarifications on installation

Browse Source
This commit is contained in:
Veronica K. B. Olsen
2021-03-29 18:51:43 +02:00
parent 518be4e630
commit 1e64a3f94c
2 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -2
View File
@@ -140,7 +140,7 @@ space only.
### Dependencies ### Dependencies
Dependencies can be installed from PyPi with: Dependencies can generally be installed from PyPi with:
```bash ```bash
pip install pyqt5 lxml pyenchant pip install pyqt5 lxml pyenchant
``` ```
@@ -175,6 +175,9 @@ Windows doesn't by default come with Python installed. If you haven't installed
from [python.org/downloads](https://www.python.org/downloads/). Remember to select "Add Python to from [python.org/downloads](https://www.python.org/downloads/). Remember to select "Add Python to
PATH" during the installation. PATH" during the installation.
The script `setup_windows.bat` can be used to create desktop and start menu icons for novelWriter.
The script will also install dependencies for you from PyPi.
## Debugging ## Debugging
If you need to debug novelWriter, you must run it from the command line. It takes a few parameters, If you need to debug novelWriter, you must run it from the command line. It takes a few parameters,
@@ -207,7 +210,7 @@ Bundled assets have the following licenses:
the main repo is available at the main repo is available at
[sdras/night-owl-vscode-theme](https://github.com/sdras/night-owl-vscode-theme). [sdras/night-owl-vscode-theme](https://github.com/sdras/night-owl-vscode-theme).
## Screenshot ## Screenshots
**novelWriter with default system theme:** **novelWriter with default system theme:**
![Screenshot 1](https://raw.githubusercontent.com/vkbo/novelWriter/main/docs/source/images/screenshot_default.png) ![Screenshot 1](https://raw.githubusercontent.com/vkbo/novelWriter/main/docs/source/images/screenshot_default.png)
docs/source/setup_linux.rst
+3 -3
View File
@@ -43,8 +43,8 @@ Step 2: Install Package (Optional)
---------------------------------- ----------------------------------
You can install novelWriter to the default location for Python packages using ``setuptools``. This 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 step is optional as you can also just put the novelWriter program folder wherever you like
instance to ``/opt/novelWriter`` and run Step 3 to set up icons and launcher. yourself. For instance in ``/opt/novelWriter``, and then run Step 3 to set up icons and launcher.
To install novelWriter to the default location, it requires that you have ``setuptools`` installed 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 on your system. If you don't have it installed, it can usually be installed from your distro's
@@ -84,7 +84,7 @@ Step 3: Create Launcher Icons
Regardless of where you extract or install the source files, you can set up a standard icon and a 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, launcher. To set up this desktop launcher, the needed icons, and the project file association,
run the following from inside the novelWriter folder: run the following from inside the novelWriter folder at the installed or final location:
.. code-block:: console .. code-block:: console