diff --git a/make.py b/make.py index 15ed18ae..859ad8ca 100755 --- a/make.py +++ b/make.py @@ -1,15 +1,17 @@ #!/usr/bin/env python3 # -*- coding: utf-8 -*- """ -This script will either build: - * A single file executable named dist/novelWriter.exe. This is a quite - slow option, and the file is fairly big. Option --onefile - * A single directory named dist/novelWriter with a novelWriter.exe, and - all dependecies included. This is the default. - * The latter can be combined with a build stage of a setup.exe file - named setup-novelwriter-.exe. Option --setup. +This make script is intended for building distributable packages of +novelWriter. These are either: -In addition, providing the --pip flag will cause the script to try to + * A single file executable named dist/novelWriter(.exe). This is a + quite slow option, and the file is fairly big. + * A single directory named dist/novelWriter with a novelWriter(.exe), + and all dependecies included. + * The latter can be combined with a build stage of a setup.exe file if + on Windows. This requires Inno Setup to be installed and in path. + +In addition, providing the pip otion will cause the script to try to install all dependencies needed for runing the build, and for running novelWriter itself. """ diff --git a/setup.py b/setup.py index 4683e3f2..c3c5710b 100755 --- a/setup.py +++ b/setup.py @@ -1,4 +1,22 @@ #!/usr/bin/env python3 +""" +The main setup script for novelWeiter. + +It runs the standard setuptool.setup() with all options taken from the +setup.cfg file. + +In addtion, a few speicalised commands are available: + + * sample: Will build a sample.zip file, which is the way the sample project is + included into distributable packages. + * qthelp: Will build a QtAssistant readable version of the novelWriter + documentation. This should also be a part of distributed packages. It allows + for reading the help offline. Otherwise, the F1 button redirects to the + online documentation only. + * launcher: Will attempt to install novelWriter icons, mime type and create a + launcher for the application. + +""" import os import sys import shutil @@ -276,7 +294,7 @@ if __name__ == "__main__": "This tool provides some additional setup commands for novelWriter.\n" "\n" "help Print the help message.\n" - "gthelp Build the help documentation for use with the QtAssistant.\n" + "qthelp Build the help documentation for use with the QtAssistant.\n" "sample Build the sample project as a zip file.\n" "launcher Install launcher icons for freedesktop systems.\n" )