diff INSTALL @ 241:06d6c351925c

*: reorganize resources, +docs, build translations with autotools
author Paper <paper@paper.us.eu.org>
date Mon, 22 Jan 2024 16:36:19 -0500
parents
children 703fb7d7c917
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/INSTALL	Mon Jan 22 16:36:19 2024 -0500
@@ -0,0 +1,26 @@
+This is just like any typical autotools-based project.
+
+To install, it's as simple as:
+	0). autoreconf -i
+			This step is only necessary if you're cloning from the repository.
+			Tarballs will have this step done already.
+	1). ./configure
+			Configures the build, finds Qt and the necessary runtime libraries.
+
+			NOTE: If you don't have Qt binaries on your PATH (e.g. MacPorts),
+			you can temporarily add it by prepending `PATH=qt_path:$PATH"
+			before configuring.
+	2). make
+			Builds the package.
+	3). make install
+			Installs the package. Use a suitable permission escalator like sudo
+			or doas.
+
+In some cases, the configure script will fail to find Qt. To solve this, put the
+path containing qmake into your PATH or configure pkg-config with the correct
+paths for Qt[5/6]Widgets.
+
+On OS X/macOS, you'll probably want an app bundle. To create this, simply call
+`scripts/osx/deploy_build.sh` from the build directory.
+	NOTE: This script relies on `macdeployqt` being in your PATH for it to work
+	      properly.