Added a launcher option to setup.py, and updated documentation

This commit is contained in:
Veronica K. B. Olsen
2020-10-17 16:58:47 +02:00
parent 3378b387cf
commit 139293b21c
4 changed files with 209 additions and 68 deletions
+5 -2
View File
@@ -2,6 +2,7 @@
The root folder of the repository contains two scripts for setup and install:
## Script `setup.py`
The `setup.py` is a standard Python setup script with a couple of additional options:
@@ -10,8 +11,10 @@ The `setup.py` is a standard Python setup script with a couple of additional opt
This requires the Qt tools to be installed on the local system, as well as the sphinx build tools
for the documentation.
* `sample`: Will create a `sample.zip` file in the `nw/assets` folder.
This is the file the New Project Wizard uses to generate an example project.
If novelWriter is run from source, this file is not needed.
This is the file the New Project Wizard uses to generate an example project.
If novelWriter is run from source, this file is not needed.
* `launcher`: Will try to copy the novelWriter icons and create a novelWriter.desktop file to launch
the application. This should work on standard Linux desktops.
To install novelWriter as a local Python package, run:
```bash
-42
View File
@@ -1,42 +0,0 @@
#!/bin/bash
cd ..
EXEC=$(pwd)/novelWriter.py
EXEC=$(echo $EXEC | sed 's_/_\\/_g')
sed "s/%%exec%%/$EXEC/g" setup/novelwriter.desktop > /usr/share/applications/novelwriter.desktop
if [ ! -d /usr/share/icons/hicolor/24x24/apps ]; then
mkdir -pv /usr/share/icons/hicolor/24x24/apps
fi
if [ ! -d /usr/share/icons/hicolor/48x48/apps ]; then
mkdir -pv /usr/share/icons/hicolor/48x48/apps
fi
if [ ! -d /usr/share/icons/hicolor/96x96/apps ]; then
mkdir -pv /usr/share/icons/hicolor/96x96/apps
fi
if [ ! -d /usr/share/icons/hicolor/256x256/apps ]; then
mkdir -pv /usr/share/icons/hicolor/256x256/apps
fi
if [ ! -d /usr/share/icons/hicolor/512x512/apps ]; then
mkdir -pv /usr/share/icons/hicolor/512x512/apps
fi
if [ ! -d /usr/share/icons/hicolor/scalable/apps ]; then
mkdir -pv /usr/share/icons/hicolor/scalable/apps
fi
if [ ! -d /usr/share/icons/hicolor/scalable/mimetypes ]; then
mkdir -pv /usr/share/icons/hicolor/scalable/mimetypes
fi
cp -v setup/icons/24x24/novelwriter.png /usr/share/icons/hicolor/24x24/apps/
cp -v setup/icons/48x48/novelwriter.png /usr/share/icons/hicolor/48x48/apps/
cp -v setup/icons/96x96/novelwriter.png /usr/share/icons/hicolor/96x96/apps/
cp -v setup/icons/256x256/novelwriter.png /usr/share/icons/hicolor/256x256/apps/
cp -v setup/icons/512x512/novelwriter.png /usr/share/icons/hicolor/512x512/apps/
cp -v setup/icons/novelwriter.svg /usr/share/icons/hicolor/scalable/apps/
cp -v setup/icons/x-novelwriter-project.svg /usr/share/icons/hicolor/scalable/mimetypes/application-x-novelwriter-project.svg
cp -v setup/mime/x-novelwriter-project.xml /usr/share/mime/packages/
update-mime-database /usr/share/mime/
update-icon-caches /usr/share/icons/*