You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-3Lines changed: 19 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,9 @@
3
3
4
4
## Installation
5
5
6
-
Download the latest release binary file from the Releases section in the sidebar. You probably want the `.whl` file. You can place this file anywhere, but I would recommend placing it in a `Plugins` folder inside your Hilltop installation, for example `C:\Hilltop\Plugins\`
6
+
### Download the Plugin files
7
+
8
+
Download the latest release binary file from the Releases section in the sidebar. You probably want the `.whl` files. It is likely that you would need to install both the 32 and 64 bit versions of the plugin. You can place this file anywhere, but I would recommend placing it in a `Plugins` folder inside your Hilltop installation, for example `C:\Hilltop\Plugins\`
7
9
8
10
Open your Hilltop directory in a terminal emulator. You can do this by navigating to the directory in File Explorer, right-clicking in white space and hitting "Open in Terminal". (In Windows 11 you might have to hit "More options" or something to bring up to bring up the Windows 10 menu for some reason.)
9
11
@@ -24,11 +26,11 @@ where `<path>` is the relative path to the plugin `.whl` or `.tar.gz` file that
24
26
For example, if your Hilltop directory is `C:\Hilltop` and you've saved your plugin file in `C:\Hilltop\Plugins`, then your command line would look like this:
@@ -39,4 +41,18 @@ Finally you need to specify the directory to which the plugin with save the qr c
39
41
LabelOutputDir = \\directory\for\qr\code\output
40
42
```
41
43
44
+
# Build instructions
45
+
46
+
This section is for developers who want to build the source binaries for release.
47
+
48
+
Due to the two supported architectures, we need to make separate releases for 32 and 64-bit architectures. Unfortunately this information cannot be passed as "platform" specifications as this will block installation of the wheel on a machine that doesn't have a CPU architecture that agrees with the Hilltop architecture.
49
+
50
+
For that reason we can specify the Hilltop architecture as a `build-number`, which is just a suffix to the version number used to differentiate different builds of the same version. This can be passed to the build backend with the following build command:
We'll use the convention that a build number of `32bit` is a plugin intended for the 32 bit Hilltop, and build number `64bit` is for 64 bit Hilltop.
42
57
58
+
Note that the above command also specifies the python version. This is just a failsafe that might prevent installations of the plugins using other python interpreters installed on the user's system.
0 commit comments